@sanity-codegen/cli
Version:
CLI for sanity-codegen
256 lines (210 loc) • 8.59 kB
Markdown
# -codegen/cli
CLI for Sanity CodeGen
[](https://oclif.io)
[](https://npmjs.org/package/@sanity-codegen/cli)
[](https://npmjs.org/package/@sanity-codegen/cli)
[](https://github.com/ricokahler/sanity-codegen/blob/master/package.json)
You may also use a config file with the name `sanity-codegen.config.ts` or `sanity-codegen.config.js`.
The CLI will walk up the file tree until it finds this file.
```ts
import { SanityCodegenConfig } from '-codegen/cli';
const config: SanityCodegenConfig = {
/**
* Optionally provide the path to your sanity schema entry point. If not
* provided, the CLI will try to get this value from your `sanity.json` file.
*/
schemaPath: './schema',
/**
* Specify a glob (powered by
* [`globby`](https://github.com/sindresorhus/globby)), a list of globs, or a
* function that returns a list of paths to specify the source files you want
* to generate types from.
*
* If `groqCodegenInclude` is provided as a function then `groqCodegenExclude`
* will not be used.
*/
groqCodegenInclude: ['./src/**/*.{js,jsx,ts,tsx}'],
/**
* Specify a glob (powered by
* [`globby`](https://github.com/sindresorhus/globby)) or a list of globs to
* specify which source files you want to exclude from type generation.
*/
groqCodegenExclude: ['**/*.test.{js,ts,tsx}', '**/node_modules'],
/**
* Optionally provide a destination path to the resulting sanity schema types.
* The default value is `schema-types.d.ts`
*/
// schemaTypesOutputPath: './schema-types.d.ts',
/**
* Optionally provide a destination path to the resulting sanity schema JSON.
* The default value is `schema-def.json`
*/
// schemaJsonOutputPath: './schema-def.json',
/**
* Optionally provide a destination path to the resulting sanity groq types.
* The default value is `query-types.d.ts`.
*/
// queryTypesOutputPath: './query-types.d.ts',
/**
* Optionally provide an input `schema-def.json` file to be used for GROQ
* codegen. This is the `schemaJsonOutputPath` by default.
*/
// schemaJsonInputPath: './schema-def.json',
/**
* Optionally provide a path to a .babelrc file. This will be passed into the
* babel options of the schema executor.
*
* If both `babelOptions` and `babelrcPath` are provided, the results will be
* merged with `babel-merge`
*/
// babelrcPath: './babelrc',
/**
* Optionally provide babel options inline. This will be passed into the babel
* options of the schema executor.
*
* Note: these options get serialized to JSON so if you need to pass any
* non-serializable babel options, you must use `babelrcPath` (can be
* `.babelrc.js`).
*
* If both `babelOptions` and `babelrcPath` are provided, the results will be
* merged with `babel-merge`
*/
// babelOptions: {
// // ...
// },
/**
* Determines from where files are relative to. Defaults to where your
* sanity-codegen config was found.
*/
// root: process.cwd(),
/**
* You can directly provide a normalized instead of using a schema-def.json.
* A normalized schema (result of the `schemaNormalizer`)
* @see schemaNormalizer
*/
// normalizedSchema: undefined,
/**
* Optionally provide a function that generates the typescript type identifer
* from the sanity type name. Use this function to override the default and
* prevent naming collisions.
*/
// generateTypeName: undefined,
/**
* This option is fed directly to prettier `resolveConfig`
*
* https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath--options
*/
// prettierResolveConfigPath: undefined,
/**
* This options is also fed directly to prettier `resolveConfig`
*
* https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath--options
*/
// prettierResolveConfigOptions: undefined,
};
export default config;
```
<!-- toc -->
* [-codegen/cli](#sanity-codegencli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g -codegen/cli
$ sanity-codegen COMMAND
running command...
$ sanity-codegen (-v|--version|version)
-codegen/cli/1.0.0-alpha.13 darwin-arm64 node-v16.13.0
$ sanity-codegen --help [COMMAND]
USAGE
$ sanity-codegen COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`sanity-codegen groq-codegen [GROQCODEGENINCLUDE]`](#sanity-codegen-groq-codegen-groqcodegeninclude)
* [`sanity-codegen help [COMMAND]`](#sanity-codegen-help-command)
* [`sanity-codegen schema-codegen [SCHEMAPATH]`](#sanity-codegen-schema-codegen-schemapath)
## `sanity-codegen groq-codegen [GROQCODEGENINCLUDE]`
parses source code files for GROQ queries and outputs TypeScript types from them
```
USAGE
$ sanity-codegen groq-codegen [GROQCODEGENINCLUDE]
ARGUMENTS
GROQCODEGENINCLUDE Provide a glob to match source files you wish to parse for GROQ queries.
OPTIONS
-h, --help
show CLI help
--configPath=configPath
Optionally provide an exact path for the CLI to look for a
sanity-codegen configuration file. If not provided, the CLI will walk up
the file system checking for `sanity-codegen.config.js` or
`sanity-codegen.config.ts`.
Any CLI flags passed with override the config options.
--groqCodegenExclude=groqCodegenExclude
Specify a glob or a list of globs to specify which source files you want
to exclude from type generation.
--queryTypesOutputPath=queryTypesOutputPath
Optionally provide a destination path to the resulting sanity groq
types. The default value is `query-types.d.ts`.
--root=root
Determines from where files are relative to. Defaults to where your
sanity-codegen config was found (if any) or the current working
directory.
--schemaJsonInputPath=schemaJsonInputPath
Optionally provide an input `schema-def.json` file to be used for GROQ
codegen. This is the `schemaJsonOutputPath` by default.
```
_See code: [lib/commands/groq-codegen.js](https://github.com/ricokahler/sanity-codegen/blob/v1.0.0-alpha.13/lib/commands/groq-codegen.js)_
## `sanity-codegen help [COMMAND]`
display help for sanity-codegen
```
USAGE
$ sanity-codegen help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.4/src/commands/help.ts)_
## `sanity-codegen schema-codegen [SCHEMAPATH]`
loads a sanity schema and generates TypeScript types from it
```
USAGE
$ sanity-codegen schema-codegen [SCHEMAPATH]
ARGUMENTS
SCHEMAPATH Optionally provide the path to your sanity schema entry point. If not
provided, the CLI will try to get this value from your sanity.json file.
OPTIONS
-h, --help
show CLI help
--babelOptions=babelOptions
Optionally provide babel options inline in a JSON blob. This will be
passed into the babel options of the schema executor.
`babelOptions` takes precedence over `babelrcPath`
--babelrcPath=babelrcPath
Optionally provide a path to a .babelrc file. This will be passed into
the babel options of the schema executor.
`babelOptions` takes precedence over `babelrcPath`
--configPath=configPath
Optionally provide an exact path for the CLI to look for a
sanity-codegen configuration file. If not provided, the CLI will walk up
the file system checking for `sanity-codegen.config.js` or
`sanity-codegen.config.ts`.
Any CLI flags passed with override the config options.
--root=root
Determines from where files are relative to. Defaults to where your
sanity-codegen config was found (if any) or the current working
directory.
--schemaJsonOutputPath=schemaJsonOutputPath
Optionally provide a destination path to the resulting sanity schema
JSON. The default value is ./schema-def.json.
--schemaTypesOutputPath=schemaTypesOutputPath
Optionally provide a destination path to the resulting sanity schema
types. The default value is ./schema-types.d.ts.
```
_See code: [lib/commands/schema-codegen.js](https://github.com/ricokahler/sanity-codegen/blob/v1.0.0-alpha.13/lib/commands/schema-codegen.js)_
<!-- commandsstop -->