Skip to content
This repository has been archived by the owner on Oct 2, 2024. It is now read-only.

Commit

Permalink
Merge pull request #413 from comigor/readme_fix
Browse files Browse the repository at this point in the history
readme fix
  • Loading branch information
vasilich6107 authored May 27, 2023
2 parents 80921aa + ee20937 commit 0301b81
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 17 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## 7.13.0-beta.2

- readme fix

## 7.13.0-beta.1

- package update
Expand Down
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- @formatter:off -->

<p align="center">
<img src="https://user-images.githubusercontent.com/735858/58768495-8ecbd600-8572-11e9-9321-4fa5ce4ea007.png" height="200">
<h1><b>Artemis</b></h1>
Expand Down Expand Up @@ -85,20 +87,16 @@ targets:

> ⚠️ Make sure your configuration file is called `build.yaml` (with `.yaml` extension, not `.yml`)!
| Option | Default value | Description | | - | - | - | | `generate_helpers` | `true` | If Artemis should generate
query/mutation helper GraphQLQuery subclasses. | | `generate_queries` | `true` | If Artemis should generate query
documents and operation names. If you are using Artemis with `graphql` library it is useful to have those queries and
operation names generated but without Atremis specific classes to exclude Artemis from dependancies | | `scalar_mapping`
| `[]` | Mapping of GraphQL and Dart types. See [Custom scalars](#custom-scalars). | | `schema_mapping` | `[]` | Mapping
of queries and which schemas they will use for code generation. See [Schema mapping](#schema-mapping). |
| `fragments_glob` | `null` | Import path to the file implementing fragments for all queries mapped in schema_mapping.
If it's assigned, fragments defined in schema_mapping will be ignored. | | `ignore_for_file` | `[]` | The linter rules
to ignore for artemis generated files. |

It's important to remember that, by default, [build](https://github.com/dart-lang/build) will
follow [Dart's package layout conventions](https://dart.dev/tools/pub/package-layout), meaning that only some folders
will be considered to parse the input files. So, if you want to reference files from a folder other than `lib/`, make
sure you've included it on `sources`:
| Option | Default value | Description |
| - | - | - |
| `generate_helpers` | `true` | If Artemis should generate query/mutation helper GraphQLQuery subclasses. |
| `scalar_mapping` | `[]` | Mapping of GraphQL and Dart types. See [Custom scalars](#custom-scalars). |
| `schema_mapping` | `[]` | Mapping of queries and which schemas they will use for code generation. See [Schema mapping](#schema-mapping). |
| `fragments_glob` | `null` | Import path to the file implementing fragments for all queries mapped in schema_mapping. If it's assigned, fragments defined in schema_mapping will be ignored. |
| `ignore_for_file` | `[]` | The linter rules to ignore for artemis generated files. |
| `generate_queries` | `true` | If Artemis should generate query documents and operation names. If you are using Artemis with `graphql` library it is useful to have those queries and operation names generated but without Atremis specific classes to exclude Artemis from dependancies |

It's important to remember that, by default, [build](https://github.com/dart-lang/build) will follow [Dart's package layout conventions](https://dart.dev/tools/pub/package-layout), meaning that only some folders will be considered to parse the input files. So, if you want to reference files from a folder other than `lib/`, make sure you've included it on `sources`:
```yaml
targets:
$default:
Expand Down
4 changes: 2 additions & 2 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
include: package:lints/recommended.yaml

analyzer:
strong-mode:
implicit-casts: false
exclude:
- example/**/*.dart
language:
strict-casts: true
linter:
rules:
overridden_fields: false
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: artemis
version: 7.13.0-beta.1
version: 7.13.0-beta.2

description: Build dart types from GraphQL schemas and queries (using Introspection Query).
homepage: https://github.com/comigor/artemis
Expand Down

0 comments on commit 0301b81

Please sign in to comment.