Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added documentation website #159

Merged
merged 4 commits into from
Oct 1, 2024
Merged

Conversation

timcreatedit
Copy link
Contributor

Description

Adds a documentation website, with a detailed Quick Start Guide

Checklist

  • My PR title is in the style of conventional commits
  • All public facing APIs are documented with dartdoc
  • I have added tests to cover my changes

Copy link

netlify bot commented Sep 29, 2024

Deploy Preview for figmage ready!

Name Link
🔨 Latest commit 690fbfe
🔍 Latest deploy log https://app.netlify.com/sites/figmage/deploys/66fac9747b8b3100088dbcb4
😎 Deploy Preview https://deploy-preview-159--figmage.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Sep 29, 2024

Coverage Report

This is an automatic coverage report for 690fbfe, proudly generated by Dart Coverage Assistant 🎯🧪.

Monorepo coverage

This repository contains 3 Dart projects. This is is the total coverage across all of them:

69.4815606627472% - warning ➡️ 0.00%

figmage

A CLI tool for generating Figma styles for Flutter

86.09904430929627% - pass ➡️ 0.00%

Coverage Details for figmage
File Line Percentage Line Count
/lib/src
command_runner.dart 98.36 61
/lib/src/commands/shared
generation_notifier.dart 73.68 19
forge_settings_providers.dart 86.67 15
/lib/src/commands/update
update_command.dart 57.69 26
/lib/src/data/generators
generator_util.dart 100.00 12
/lib/src/data/generators/file_generators
base_file_generator.dart 93.10 29
color_file_generator.dart 100.00 6
number_file_generator.dart 33.33 6
padding_file_generator.dart 22.22 9
spacer_file_generator.dart 22.22 9
typography_file_generator.dart 100.00 7
/lib/src/data/generators/reference_generators
padding_generator.dart 100.00 32
spacer_generator.dart 100.00 33
reference_theme_class_generator.dart 100.00 52
/lib/src/data/generators/theme_extension_generators
color_theme_extension_generator.dart 100.00 5
number_theme_extension_generator.dart 100.00 4
text_style_theme_extension_generator.dart 96.30 27
mode_theme_extension_generator.dart 100.00 157
/lib/src/data/repositories
dart_code_file_writer_repository.dart 0.00 7
dart_post_generation_repository.dart 100.00 17
figma_styles_repository.dart 0.00 46
figma_variables_repository.dart 83.15 89
yaml_config_repository.dart 82.61 23
/lib/src/data/util/converters
string_dart_conversion_x.dart 100.00 20
color_conversion_x.dart 100.00 8
type_style_conversion_x.dart 100.00 14
/lib/src/domain/models/config
config.dart 100.00 42
config.g.dart 100.00 71
/lib/src/domain/models/style
design_style.dart 70.00 20
/lib/src/domain/models/tokens_by_file_type
tokens_by_type.dart 100.00 19
/lib/src/domain/models/typography
typography.dart 100.00 1
/lib/src/domain/models/variable
variable.dart 96.77 31
/lib/src/domain/models/variable/alias_or
alias_or.dart 100.00 5
/lib/src/domain/providers
logger_providers.dart 100.00 1
pub_updater_providers.dart 100.00 1
config_providers.dart 100.00 4
design_token_providers.dart 97.06 68
figmage_package_generator_providers.dart 14.81 27
file_writer_providers.dart 22.22 9
generator_providers.dart 100.00 29
library_provider.dart 100.00 14
post_generation_providers.dart 87.50 8
/lib/src/domain/repositories
file_writer_repository.dart 0.00 2
post_generation_repository.dart 100.00 2
styles_repository.dart 83.33 6
variables_repository.dart 100.00 5
config_repository.dart 100.00 2
/lib/src/domain/shared
dart_symbol_conversion.dart 100.00 14
reserved_words.dart 100.00 1
/lib/src/domain/util
token_filter_x.dart 85.29 34
values_by_name_by_mode_x.dart 100.00 2

figma_variables_api

Figma REST API for variables.

40.778097982708935% - fail ➡️ 0.00%

Coverage Details for figma_variables_api
File Line Percentage Line Count
/lib/src
client.dart 0.00 67
query.dart 0.00 16
/lib/src/dto/file_styles_response
file_styles_response.g.dart 0.00 53
file_styles_response.dart 0.00 13
/lib/src/dto/nodes
node_content.dart 100.00 16
node_content.g.dart 33.80 71
nodes_response.g.dart 0.00 46
nodes_response.dart 0.00 12
/lib/src/dto/styles
styles_response.g.dart 0.00 44
styles_response.dart 0.00 12
/lib/src/dto/variable
variable_dto.dart 100.00 17
variable_dto.g.dart 68.92 74
/lib/src/dto/variable_collection
variable_collection_dto.g.dart 72.13 61
variable_collection_dto.dart 100.00 14
/lib/src/dto/variable_mode
variable_mode_dto.dart 100.00 6
variable_mode_dto.g.dart 40.00 20
/lib/src/dto/variable_mode_value
variable_mode_value_dto.dart 100.00 52
variable_mode_value_dto.g.dart 52.63 38
/lib/src/dto/variable_response
variables_response_dto.g.dart 37.04 27
variables_response_dto.dart 100.00 6
/lib/src/dto/variables_meta
variables_meta_dto.dart 66.67 6
variables_meta_dto.g.dart 47.83 23

figmage_package_generator

A generator for an empty figmage styles dart package

100% - pass ➡️ 0.00%

Coverage Details for figmage_package_generator
File Line Percentage Line Count
/lib/src
figmage_package_generator.dart 100.00 17
token_file_type.dart 100.00 9

Copy link
Contributor

@JesperBllnbm JesperBllnbm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@timcreatedit timcreatedit merged commit fd770a5 into main Oct 1, 2024
7 checks passed
@timcreatedit timcreatedit deleted the docs/documentation-website branch October 1, 2024 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants