repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/meta/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "meta",
"$schema": "https://json-schema.org/schema",
"description": "Generate a meta function for a given route.",
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the meta function in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | 29a9f8eba8ccc11aabdbf144314e8f20bc7e83ef | 2023-07-19T14:42:13 | packages/react/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookStories",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a project.",
"examplesFile": "../../../docs/stories-examples.md",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `project` by default.",
"type": "string",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"generateCypressSpecs": {
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-priority": "important",
"x-prompt": "For which project do you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate React Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | 9352f2ee987f543a634d20a2af59c7189aa0acf4 | 2022-07-11T12:27:33 | packages/angular/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Remote Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:remote appName --host=host --port=4201",
"description": "Create an Angular app with configuration in place for Module Federation. If host is provided, attach this remote app to host app's configuration."
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"host": {
"$default": {
"$source": "projectName"
},
"description": "The name of the host app to attach this remote app to.",
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the remote Angular app.",
"type": "string"
},
"port": {
"description": "The port on which this app should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"generateCypressSpecs": {
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18."
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 09c6ccb2666f98014a206e23187a2794642a579c | 2022-09-28T15:08:01 | packages/next/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Next.js Application for Nx.",
"examples": [
{
"command": "nx g app myapp --directory=myorg",
"description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
}
],
"properties": {
"customServer": {
"default": false,
"description": "Use a custom Express server for the Next.js application.",
"type": "boolean"
},
"directory": {
"alias": "d",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"server": {
"description": "The server script path to be used with next.",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. `babel`, `style`).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"swc": {
"default": true,
"description": "Enable the Rust-based compiler SWC to compile JS/TS files.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Next.js Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | d9aef75bd564cb2cec0bdbb5929b63bef2a65585 | 2021-02-11T02:30:55 | packages/react/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"id": "storybook-stories",
"properties": {
"generateCypressSpecs": {
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"description": "Library or application name",
"type": "string",
"x-prompt": "What's name of the project for which you want to generate stories?"
}
},
"required": [
"project"
],
"type": "object"
} | MIT | en |
nrwl/nx | e96dfe575af3fac71c7e74d549d7dbc0502a6d73 | 2023-01-06T16:36:46 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a web application using `swc` or `babel` as compiler.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"webpack",
"none",
"vite"
],
"type": "string",
"x-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl)[ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/esbuild/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxEsBuildProject",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add esbuild configuration to a project.",
"examplesFile": "../../../docs/configuration-examples.md",
"properties": {
"buildTarget": {
"default": "build",
"description": "The build target to add.",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"main": {
"alias": "entryFile",
"description": "Path relative to the workspace root for the main entry file. Defaults to `<project-root>/src/main.ts` or `<project-root>src/index.ts`, whichever is found.",
"type": "string",
"x-priority": "important"
},
"platform": {
"default": "node",
"description": "Platform target for outputs.",
"enum": [
"browser",
"node",
"neutral"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the project.",
"type": "string",
"x-dropdown": "project",
"x-priority": "important",
"x-prompt": "What is the name of the project to set up a esbuild for?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipValidation": {
"default": false,
"description": "Do not perform any validation on existing project.",
"type": "boolean",
"x-priority": "internal"
},
"tsConfig": {
"description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to `<project-root>/tsconfig.app.json` or `<project-root>/tsconfig.lib.json`, whichever is found.",
"type": "string",
"x-priority": "important"
}
},
"required": [],
"title": "Add esbuild configuration to a project",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/guard/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGuardGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"d",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest guard language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the guard.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Guard Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | 93f64dac8e2218b0e0e1419cc6f968350ff52e46 | 2022-10-10T13:32:04 | packages/angular/src/generators/setup-mf/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularMFSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given Angular Application.",
"examplesFile": "../../../docs/setup-mf-examples.md",
"properties": {
"appName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Module Federation configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate a Module Federation configuration for?"
},
"e2eProjectName": {
"description": "The project name of the associated E2E project for the application. This is only required for Cypress E2E projects that do not follow the naming convention `<appName>-e2e`.",
"type": "string"
},
"federationType": {
"default": "static",
"description": "Use either Static or Dynamic Module Federation pattern for the application.",
"enum": [
"static",
"dynamic"
],
"type": "string"
},
"host": {
"description": "The name of the host application that the remote application will be consumed by.",
"type": "string"
},
"mfType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"description": "The prefix to use for any generated component.",
"type": "string"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"routing": {
"description": "Generate a routing setup to allow a host application to route to the remote application.",
"type": "boolean"
},
"skipE2E": {
"default": false,
"description": "Do not set up E2E related config.",
"type": "boolean"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether the application is a standalone application.",
"type": "boolean"
}
},
"required": [
"appName",
"mfType"
],
"title": "Generate Module Federation Setup for Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | 25d6ec3a921d09cb95ad81ce2471e11e3f51e9d1 | 2023-11-07T20:45:42 | packages/angular/src/generators/setup-ssr/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularUniversalSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create the additional configuration required to enable SSR via Angular Universal for an Angular application.",
"properties": {
"appId": {
"default": "serverApp",
"description": "The `appId` to use with `withServerTransition`. _Note: This is only used in Angular versions <16.0.0. It's deprecated since Angular 16 and not supported since Angular 17._",
"format": "html-selector",
"type": "string"
},
"hydration": {
"description": "Set up Hydration for the SSR application. It defaults to `true` for Angular versions >= 17.0.0. Otherwise, it defaults to `false`. _Note: This is only supported in Angular versions >= 16.0.0_.",
"type": "boolean"
},
"main": {
"default": "main.server.ts",
"description": "The name of the main entry-point file.",
"format": "path",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Angular Universal configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate an Angular Universal configuration for?"
},
"rootModuleClassName": {
"default": "AppServerModule",
"description": "The name of the root module class.",
"type": "string"
},
"rootModuleFileName": {
"default": "app.server.module.ts",
"description": "The name of the root module file",
"format": "path",
"type": "string"
},
"serverFileName": {
"default": "server.ts",
"description": "The name of the Express server file.",
"type": "string"
},
"serverPort": {
"default": 4000,
"description": "The port for the Express server.",
"type": "number"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
},
"standalone": {
"description": "Use Standalone Components to bootstrap SSR.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Generate Angular Universal (SSR) setup for an Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | e71cef0ba9db87823cfa94fbe74550a1e20761d0 | 2021-02-11T05:39:49 | packages/next/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"id": "NxNextNgInit",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified e2e test runner",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init Next Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 06f84b3326ad80103b0edff8bdfbc2436bf388f0 | 2021-02-02T23:56:35 | packages/web/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "NxWebInit",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified e2e test runner",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init Web Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | b311cbf8e33a9c11740bcda291a9f76e4ca19352 | 2023-07-21T15:09:09 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean"
},
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 24b1ab5463f46925d547fffc791050e699f86c90 | 2023-08-03T15:16:35 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React application for Nx.",
"examples": [
{
"command": "nx g app myapp --directory=myorg",
"description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
},
{
"command": "nx g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "nx g app myapp --routing",
"description": "Set up React Router"
}
],
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"vite",
"webpack",
"rspack"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating `nx.json` with default options based on values provided to this app.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ] (DEPRECATED)",
"value": "styl"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | 3a8ec4f53577218603726b7571470e9f26fae453 | 2023-01-23T22:48:58 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"bundler": {
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"x-priority": "important"
},
"configureCypress": {
"default": true,
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"storybook7betaConfiguration": {
"default": false,
"description": "Configure your workspace to use Storybook 7, even though Storybook v7 is still in beta.",
"hidden": true,
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/service/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestServiceGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Service Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest service language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the service.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Service Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a3c08a9153360371ee09771389299201b3407e00 | 2021-05-28T13:35:34 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
},
{
"command": "g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to myapp"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "d",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '*.css' rather than '*.module.css').",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 015f1b78f4d34c6e2b4a9457f82e0f46c04c742a | 2021-12-09T21:16:35 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
},
{
"command": "g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to myapp"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "Which compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '*.css' rather than '*.module.css').",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 4eb7cc7bf170cd48dd87fdd0dd387d3592beec69 | 2023-03-31T15:22:18 | packages/vite/src/generators/vitest/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "Vitest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate a Vitest setup for a project.",
"properties": {
"coverageProvider": {
"default": "c8",
"description": "Coverage provider to use.",
"enum": [
"c8",
"istanbul"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "Do not generate separate spec files and set up in-source testing.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project to test.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipViteConfig": {
"default": false,
"description": "Skip generating a vite config file.",
"type": "boolean"
},
"testTarget": {
"description": "The test target of the project to be transformed to use the @nrwl/vite:test executor.",
"hidden": true,
"type": "string"
},
"uiFramework": {
"default": "none",
"description": "UI framework to use with vitest.",
"enum": [
"react",
"none"
],
"type": "string"
}
},
"required": [
"project"
],
"title": "Vitest",
"type": "object"
} | MIT | en |
nrwl/nx | 2f91d962e846eda2790974d4eea664a6eb824e59 | 2022-09-27T09:04:28 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"properties": {
"configureCypress": {
"default": true,
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean",
"x-prompt": "Add a Storybook Test-Runner target?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-prompt": "Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 016c89fed619785fa1a1408a502537f87d944c79 | 2023-08-22T16:28:23 | packages/plugin/src/generators/create-package/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginCreatePackage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a framework package that uses Nx CLI.",
"examplesFile": "../../../docs/generators/create-package-examples.md",
"properties": {
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"directory": {
"description": "A directory where the app is placed.",
"type": "string"
},
"e2eProject": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the e2e project.",
"type": "string",
"x-prompt": "What is the name of the e2e project?"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The package name of cli, e.g. `create-framework-package`. Note this must be a valid NPM name to be published.",
"pattern": "create-.+|^@.+/create(?:-.+)?",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the generator project.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for the generator?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Create a framework package",
"type": "object"
} | MIT | en |
nrwl/nx | a19fbb1ddba384932e07d0df06dfe6f182cd8782 | 2023-06-13T18:32:06 | packages/next/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Library for an Nx workspace.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"globalCss": {
"default": false,
"description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ] (DEPRECATED)",
"value": "styl"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 920352215cb7f9e8f1e61c2001440b75db522844 | 2023-04-28T16:32:06 | packages/react-native/src/executors/build-ios/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Build iOS app.",
"examplesFile": "../../../docs/build-ios-examples.md",
"presets": [
{
"keys": [
"simulator"
],
"name": "Build iOS for a simulator"
},
{
"keys": [
"device"
],
"name": "Build iOS for a device"
},
{
"keys": [
"udid"
],
"name": "Build iOS for a device with udid"
},
{
"keys": [
"install"
],
"name": "Run `pod install` before building iOS app"
}
],
"properties": {
"buildFolder": {
"default": "./build",
"description": "Location for iOS build artifacts. Corresponds to Xcode's \"-derivedDataPath\". Relative to ios directory",
"type": "string"
},
"device": {
"description": "Explicitly set device to use by name. The value is not required if you have a single device connected.",
"type": "string"
},
"extraParams": {
"description": "Custom params that will be passed to xcodebuild command.",
"type": "string"
},
"install": {
"description": "Runs `pod install` for native modules before building iOS app.",
"type": "boolean"
},
"interactive": {
"description": "Explicitly select which scheme and configuration to use before running a build",
"type": "boolean"
},
"mode": {
"default": "Debug",
"description": "Explicitly set the scheme configuration to use",
"examples": [
"Debug",
"Release"
],
"type": "string",
"x-priority": "important"
},
"packager": {
"default": true,
"description": "Launch packager while building",
"type": "boolean"
},
"port": {
"default": 8081,
"description": "The port where the packager server is listening on.",
"type": "number"
},
"resetCache": {
"default": false,
"description": "Resets metro cache.",
"type": "boolean"
},
"scheme": {
"description": "Explicitly set Xcode scheme to use",
"type": "string"
},
"simulator": {
"description": "Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: \"iPhone 6 (10.0)\"",
"examples": [
"iPhone 14",
"iPhone 13",
"iPhone 12",
"iPhone 11",
"iPhone X"
],
"type": "string",
"x-priority": "important"
},
"sync": {
"default": true,
"description": "Syncs npm dependencies to `package.json` (for React Native autolink).",
"type": "boolean"
},
"udid": {
"description": "Explicitly set device to use by udid",
"type": "string"
},
"verbose": {
"description": "Do not use xcbeautify or xcpretty even if installed",
"type": "boolean"
},
"xcconfig": {
"description": "Explicitly set xcconfig to use",
"type": "string"
}
},
"required": [],
"title": "React Native Build iOS executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 3b5bf6d1d177188017d0c92d251bcd61a62686b4 | 2023-12-13T16:07:08 | packages/remix/src/generators/setup/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixSetup",
"$schema": "http://json-schema.org/schema",
"description": "Generate initial files required for Remix to work within the workspace.",
"properties": {
"packageManager": {
"description": "The package manager to setup for",
"enum": [
"yarn",
"npm",
"pnpm"
],
"type": "string"
}
},
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | d00fc1d590b2d5a36fac13ac5a02b45c35f1786e | 2022-10-04T14:46:36 | packages/angular/src/generators/add-linting/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularAddLintingGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds linting configuration to an Angular project.",
"examples": [
{
"command": "nx g @nrwl/angular:add-linting --prefix=cool --projectName=cool-lib --projectRoot=libs/cool-lib",
"description": "Adds ESLint with Angular-specific rules for an existing project named `cool-lib` with the [prefix](https://angular.io/guide/styleguide#style-02-07) `cool`"
}
],
"properties": {
"prefix": {
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"projectName": {
"description": "The name of the project.",
"type": "string"
},
"projectRoot": {
"description": "The path to the root of the selected project.",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [
"prefix",
"projectName",
"projectRoot"
],
"title": "Add linting to an Angular project.",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/controller/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestControllerGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Controller Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest controller language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "Allows specification of the declaring module.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the controller.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Controller Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 2f91d962e846eda2790974d4eea664a6eb824e59 | 2022-09-27T09:04:28 | packages/storybook/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Storybook configuration to a UI library or an application.",
"properties": {
"configureCypress": {
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean",
"x-prompt": "Add a Storybook Test-Runner target?"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Added at root by default.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
},
"uiFramework": {
"description": "Storybook UI Framework to use.",
"enum": [
"@storybook/angular",
"@storybook/react",
"@storybook/react-native",
"@storybook/html",
"@storybook/web-components",
"@storybook/vue",
"@storybook/vue3",
"@storybook/svelte"
],
"type": "string",
"x-prompt": "What UI framework plugin should storybook use?"
}
},
"required": [
"name"
],
"title": "Storybook Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 369ed3589427e13f3b1d520507737f65b5428efe | 2024-02-02T19:32:48 | packages/remix/generators.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://json-schema.org/schema",
"extends": [
"@nx/react"
],
"generators": {
"action": {
"description": "Add an action function to an existing route",
"implementation": "./src/generators/action/action.impl",
"schema": "./src/generators/action/schema.json"
},
"application": {
"aliases": [
"app"
],
"description": "Generate a new Remix application",
"implementation": "./src/generators/application/application.impl#remixApplicationGeneratorInternal",
"schema": "./src/generators/application/schema.json",
"x-type": "application"
},
"cypress-component-configuration": {
"description": "Generate a Cypress Component Testing configuration for a Remix project",
"implementation": "./src/generators/cypress-component-configuration/cypress-component-configuration.impl#cypressComponentConfigurationGeneratorInternal",
"schema": "./src/generators/cypress-component-configuration/schema.json"
},
"error-boundary": {
"description": "Add an ErrorBoundary to an existing route",
"implementation": "./src/generators/error-boundary/error-boundary.impl",
"schema": "./src/generators/error-boundary/schema.json"
},
"init": {
"description": "Initialize the `@nx/remix` plugin.",
"hidden": true,
"implementation": "./src/generators/init/init#remixInitGeneratorInternal",
"schema": "./src/generators/init/schema.json"
},
"library": {
"aliases": [
"lib"
],
"description": "Generate a new library",
"implementation": "./src/generators/library/library.impl#remixLibraryGeneratorInternal",
"schema": "./src/generators/library/schema.json",
"x-type": "library"
},
"loader": {
"description": "Add a loader function to an existing route",
"implementation": "./src/generators/loader/loader.impl",
"schema": "./src/generators/loader/schema.json"
},
"meta": {
"description": "Add a meta function to an existing route",
"implementation": "./src/generators/meta/meta.impl",
"schema": "./src/generators/meta/schema.json"
},
"preset": {
"description": "Generate a new Remix workspace",
"hidden": true,
"implementation": "./src/generators/preset/preset.impl",
"schema": "./src/generators/preset/schema.json"
},
"resource-route": {
"description": "Generate a new resource route",
"implementation": "./src/generators/resource-route/resource-route.impl",
"schema": "./src/generators/resource-route/schema.json"
},
"route": {
"description": "Generate a new route",
"implementation": "./src/generators/route/route.impl",
"schema": "./src/generators/route/schema.json"
},
"setup": {
"description": "Setup a Remix in an existing workspace",
"hidden": true,
"implementation": "./src/generators/setup/setup.impl",
"schema": "./src/generators/setup/schema.json"
},
"setup-tailwind": {
"description": "Generates a TailwindCSS configuration for the Remix application",
"implementation": "./src/generators/setup-tailwind/setup-tailwind.impl",
"schema": "./src/generators/setup-tailwind/schema.json"
},
"storybook-configuration": {
"description": "Generates a Storybook configuration for a Remix application",
"implementation": "./src/generators/storybook-configuration/storybook-configuration.impl#remixStorybookConfiguration",
"schema": "./src/generators/storybook-configuration/schema.json"
},
"style": {
"description": "Generates a new stylesheet and adds it to an existing route",
"implementation": "./src/generators/style/style.impl",
"schema": "./src/generators/style/schema.json"
}
},
"name": "NxRemix",
"version": "0.0.1"
} | MIT | en |
nrwl/nx | d91c7ca4ec6c3eb6ffd7e4eb0fda4a61a5b5bd8c | 2022-09-30T11:02:05 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"cli": {
"description": "CLI powering the workspace.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"standaloneConfig": {
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl)[ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 739e2e7115ff057ec923ef71dc09f2d73bef2977 | 2024-04-23T15:27:09 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "https://json-schema.org/schema",
"additionalProperties": true,
"cli": "nx",
"description": "Create an empty workspace.",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"playwright",
"cypress",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"nextAppDir": {
"default": true,
"description": "Enable the App Router for this project.",
"type": "boolean"
},
"nextSrcDir": {
"default": true,
"description": "Generate a `src` directory for this project.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"prefix": {
"description": "The prefix to use for Angular component and directive selectors.",
"type": "string"
},
"preset": {
"description": "What to create in the new workspace.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | bb9f880a8e1c808a8e3b31e842c88e3a0d569e4e | 2023-08-22T14:10:54 | packages/express/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxExpressApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead `ts-jest`.",
"type": "boolean",
"x-deprecated": "Use --swcJest instead for faster compilation"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"swcJest": {
"default": false,
"description": "Use `@swc/jest` instead `ts-jest` for faster test compilation.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a22bd54f3f932fc2ddcb2a5cee0f769eaf68a355 | 2023-01-16T12:19:33 | packages/angular/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Host Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:host appName --remotes=remote1",
"description": "Create an Angular application with configuration in place for Module Federation. If the `remotes` option is provided, attach the remote application to this application's configuration"
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the host Angular application.",
"type": "string"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"remotes": {
"description": "The names of the remote applications to add to the host.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean",
"x-priority": "important"
},
"standalone": {
"default": false,
"description": "Whether to generate a host application that uses standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Host Application",
"type": "object"
} | MIT | en |
nrwl/nx | e240339f339385e1e5b0ef0a74a0955568577163 | 2022-12-09T19:36:09 | packages/js/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a TypeScript Library.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"buildable": {
"default": true,
"description": "Generate a buildable library.",
"type": "boolean"
},
"bundler": {
"default": "none",
"description": "The bundler to use.",
"enum": [
"none",
"esbuild",
"rollup",
"vite",
"webpack"
],
"type": "string"
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"config": {
"default": "project",
"description": "Determines whether the project's executors should be configured in `workspace.json`, `project.json` or as npm scripts.",
"enum": [
"workspace",
"project",
"npm-scripts"
],
"type": "string"
},
"directory": {
"description": "A directory where the lib is placed.",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib.",
"type": "string"
},
"includeBabelRc": {
"description": "Include a .babelrc configuration to compile TypeScript files",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"skipTypeCheck": {
"default": false,
"description": "Whether to skip TypeScript type checking for SWC compiler.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if unitTestRunner is set to jest.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [
"name"
],
"title": "Create a TypeScript Library",
"type": "object"
} | MIT | en |
nrwl/nx | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | packages/node/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"rootDir": {
"alias": "srcRootForCompilationRoot",
"description": "Sets the rootDir for TypeScript compilation. When not defined, it uses the project's root property, or srcRootForCompilationRoot if it is defined.",
"type": "string"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using --directory)",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting)",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if unitTestRunner is set to jest",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Node Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 5d1c8eacd7b3f919a28018a8069fa6a4e7711a45 | 2023-01-30T10:56:19 | packages/nest/src/generators/service/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestServiceGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Service Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest service language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the service.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Service Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | e45c2f24bab36a72c3481ffbd605b6003a6591f2 | 2022-08-02T18:37:23 | packages/js/executors.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"builders": {
"node": {
"description": "Execute a Node application.",
"implementation": "./src/executors/node/compat",
"schema": "./src/executors/node/schema.json"
},
"swc": {
"description": "Build a project using SWC.",
"implementation": "./src/executors/swc/compat",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/compat",
"schema": "./src/executors/tsc/schema.json"
}
},
"executors": {
"node": {
"description": "Execute a Node application.",
"implementation": "./src/executors/node/node.impl",
"schema": "./src/executors/node/schema.json"
},
"swc": {
"description": "Build a project using SWC.",
"implementation": "./src/executors/swc/swc.impl",
"schema": "./src/executors/swc/schema.json"
},
"tsc": {
"description": "Build a project using TypeScript.",
"implementation": "./src/executors/tsc/tsc.impl",
"schema": "./src/executors/tsc/schema.json"
}
}
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/vue/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueStorybookConfigure",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a Vue project.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Vue Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a web application using `swc` or `babel` as compiler.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"webpack",
"none",
"vite"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 4eb7cc7bf170cd48dd87fdd0dd387d3592beec69 | 2023-03-31T15:22:18 | packages/storybook/src/generators/cypress-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "cypress-configure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add cypress E2E app to test a ui library that is set up for Storybook.",
"properties": {
"ciTargetName": {
"description": "The name of the devServerTarget to use for the Cypress CI configuration. Used to control if using <storybook-project>:static-storybook:ci or <storybook-project>:storybook:ci",
"type": "string",
"x-priority": "internal"
},
"directory": {
"description": "A directory where the project is placed.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate the cypress E2E app.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate the Cypress E2E app?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
}
},
"required": [
"name"
],
"title": "Cypress Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/react-native/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeStorybookStories",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "React native Storybook stories.",
"properties": {
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"description": "Library or application name.",
"type": "string",
"x-prompt": "What's the name of the project for which you want to generate stories?"
}
},
"required": [
"project"
],
"title": "React native Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | a25e081a84509d83db5c5c4c27d2898dcad79f65 | 2021-01-25T17:52:30 | packages/workspace/src/generators/remove/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Remove a project from the workspace",
"examples": [
{
"command": "g @nrwl/workspace:remove my-feature-lib",
"description": "Remove my-feature-lib from the workspace"
},
{
"command": "g @nrwl/workspace:remove my-feature-lib --forceRemove",
"description": "Force removal of my-feature-lib from the workspace"
}
],
"id": "NxWorkspaceRemove",
"properties": {
"forceRemove": {
"aliases": [
"force-remove"
],
"default": false,
"description": "When true, forces removal even if the project is still in use.",
"type": "boolean"
},
"projectName": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "project",
"description": "The name of the project to remove",
"type": "string"
},
"skipFormat": {
"aliases": [
"skip-format"
],
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"projectName"
],
"title": "Nx Remove",
"type": "object"
} | MIT | en |
nrwl/nx | bdcbac4445df85a8f861ac70465eb641e025e8de | 2021-10-15T22:07:12 | packages/nest/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestLibraryGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"controller": {
"default": false,
"description": "Include a controller with the library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the library is placed.",
"type": "string"
},
"global": {
"default": false,
"description": "Add the Global decorator to the generated module.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"service": {
"default": false,
"description": "Include a service with the library.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"target": {
"default": "es6",
"description": "The ES target, Nest suggest using es6 or higher.",
"enum": [
"es5",
"es6",
"esnext",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020"
],
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment for jest, for node applications this should stay as node unless doing DOM testing.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a NestJS Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 8311a172d77e316c34a7689cbe8679a045cc8c50 | 2021-10-26T10:12:53 | packages/angular/src/generators/library-secondary-entry-point/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularLibrarySecondaryEntryPoint",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"library": {
"description": "The name of the library to create the secondary entry point for.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What library would you like to create the secondary entry point for?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the secondary entry point.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the secondary entry point?"
},
"skipModule": {
"default": false,
"description": "Skip generating a module for the secondary entry point.",
"type": "boolean"
}
},
"required": [
"name",
"library"
],
"title": "Creates a secondary entry point for a library",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/decorator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestDecoratorGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Decorator Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"language": {
"description": "Nest decorator language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the decorator.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"name"
],
"title": "Nest Decorator Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 6141f44203898277adb8244db4200fcc3cea207f | 2024-01-17T19:22:58 | packages/web/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Web Plugin.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Init Web Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 11fcb8f2d41beff1c58f8b144d2fd4ccce7f1ac8 | 2023-09-18T16:11:38 | packages/react/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Remote Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss.",
"type": "boolean"
},
"host": {
"description": "The host / shell application for this remote.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the remote application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the remote application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "DEPRECATD: Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 5e51cd6eb5e3555c0e6565608424fe2bb03082b1 | 2023-08-02T20:14:17 | packages/playwright/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPlaywrightInit",
"$schema": "http://json-schema.org/schema",
"description": "Initializes a Playwright project in the current workspace.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipInstall": {
"default": false,
"description": "Skip running `playwright install`. This is to ensure that playwright browsers are installed.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Playwright Init Generator",
"type": "object"
} | MIT | en |
nrwl/nx | 6cb159e9f7942332343f9d016ed77594f4e7db7b | 2023-06-22T21:38:54 | packages/nest/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestLibraryGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a NestJS Library for Nx.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean",
"x-priority": "important"
},
"controller": {
"default": false,
"description": "Include a controller with the library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the library is placed.",
"type": "string"
},
"global": {
"default": false,
"description": "Add the Global decorator to the generated module.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"service": {
"default": false,
"description": "Include a service with the library.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the name of the module of the library.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"target": {
"default": "es2021",
"description": "The ES target, Nest suggest using es2021 or higher.",
"enum": [
"es5",
"es6",
"esnext",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020",
"es2021"
],
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment for jest, for node applications this should stay as node unless doing DOM testing.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a NestJS Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/gateway/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGatewayGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Gateway Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"language": {
"description": "Nest gateway language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the gateway.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Gateway Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 7942ea3c835bcc94a158b34f211ad32ecfdffb1f | 2023-10-26T16:53:02 | packages/js/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a TypeScript Library.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"buildable": {
"default": true,
"description": "Generate a buildable library.",
"type": "boolean",
"x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
},
"bundler": {
"default": "tsc",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"swc",
"tsc",
"rollup",
"vite",
"esbuild",
"none"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
},
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets",
"enum": [
"tsc",
"swc"
],
"type": "string",
"x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
},
"config": {
"default": "project",
"description": "Determines whether the project's executors should be configured in `workspace.json`, `project.json` or as npm scripts.",
"enum": [
"workspace",
"project",
"npm-scripts"
],
"type": "string",
"x-priority": "internal"
},
"directory": {
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Required for publishable library.",
"type": "string",
"x-priority": "important"
},
"includeBabelRc": {
"description": "Include a .babelrc configuration to compile TypeScript files",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a library with a minimal setup. No README.md generated.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the generated file name.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean",
"x-priority": "internal"
},
"skipTypeCheck": {
"default": false,
"description": "Whether to skip TypeScript type checking for SWC compiler.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment to use if unitTestRunner is set to jest or vitest.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [
"name"
],
"title": "Create a TypeScript Library",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/error-boundary/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixErrorBoundary",
"$schema": "https://json-schema.org/schema",
"description": "Generate an ErrorBoundary for a given route.",
"examples": [
{
"command": "g error-boundary --routePath=apps/demo/app/routes/my-route.tsx",
"description": "Generate an ErrorBoundary for my-route.tsx"
}
],
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the error boundary in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"description": "The path to route file relative to the project root.",
"type": "string"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files after generation.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"path"
],
"title": "Create an ErrorBoundary for a Route",
"type": "object"
} | MIT | en |
nrwl/nx | 2128f8e3e2d79397892aabad57ae69690d5aaa19 | 2023-07-11T20:47:56 | packages/playwright/src/executors/playwright/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Run Playwright tests.",
"properties": {
"browser": {
"description": "Browser to use for tests, one of 'all', 'chromium', 'firefox' or 'webkit'. If a playwright config is provided/discovered then the browserName value is expected from the configured 'projects'",
"type": "string",
"x-priority": "important"
},
"config": {
"description": "Configuration file, or a test directory with optional",
"type": "string",
"x-completion-glob": "playwright?(*)@(.js|.cjs|.mjs|.ts|.cts|.mtx)",
"x-completion-type": "file",
"x-priority": "important"
},
"debug": {
"description": "Run tests with Playwright Inspector. Shortcut for 'PWDEBUG=1' environment variable and '--timeout=0',--max-failures=1 --headed --workers=1' options",
"type": "boolean"
},
"forbidOnly": {
"description": "Fail if test.only is called",
"type": "boolean"
},
"fullyParallel": {
"description": "Run all tests in parallel",
"type": "boolean"
},
"globalTimeout": {
"description": "Maximum time this test suite can run in milliseconds",
"type": "number"
},
"grep": {
"alias": "g",
"description": "Only run tests matching this regular expression",
"type": "string"
},
"grepInvert": {
"alias": "gv",
"description": "Only run tests that do not match this regular expression",
"type": "string"
},
"headed": {
"description": "Run tests in headed browsers",
"type": "boolean",
"x-priority": "important"
},
"ignoreSnapshots": {
"description": "Ignore screenshot and snapshot expectations",
"type": "boolean"
},
"list": {
"description": "Collect all the tests and report them, but do not run",
"type": "boolean"
},
"maxFailures": {
"alias": "x",
"description": "Stop after the first N failures",
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"noDeps": {
"description": "Do not run project dependencies",
"type": "boolean"
},
"output": {
"description": "Folder for output artifacts",
"type": "string"
},
"passWithNoTests": {
"default": true,
"description": "Makes test run succeed even if no tests were found",
"type": "boolean"
},
"project": {
"description": "Only run tests from the specified list of projects",
"items": {
"type": "string"
},
"type": "array"
},
"quiet": {
"alias": "q",
"description": "Suppress stdio",
"type": "boolean"
},
"repeatEach": {
"description": "Run each test N times",
"type": "number"
},
"reporter": {
"description": "Reporter to use, comma-separated, can be 'list', 'line', 'dot', 'json', 'junit', 'null', 'github', 'html', 'blob'. To configure reporter options, use the playwright configuration.",
"enum": [
"list",
"line",
"dot",
"json",
"junit",
"null",
"github",
"html",
"blob"
],
"type": "string"
},
"retries": {
"description": "Maximum retry count for flaky tests, zero for no retries",
"type": "number"
},
"shard": {
"description": "Shard tests and execute only the selected shard, specify in the form 'current/all', 1-based, for example '3/5'",
"type": "string"
},
"timeout": {
"description": "Specify test timeout threshold in milliseconds, zero for unlimited",
"type": "number"
},
"trace": {
"description": "Force tracing mode, can be 'on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure'",
"enum": [
"on",
"off",
"on-first-retry",
"on-all-retries",
"retain-on-failure"
],
"type": "string"
},
"ui": {
"description": "Run tests in interactive UI mode",
"type": "boolean"
},
"uiHost": {
"description": "Host to serve UI on; specifying this option opens UI in a browser tab",
"type": "string"
},
"uiPort": {
"description": "Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab",
"type": "string"
},
"updateSnapshots": {
"alias": "u",
"description": "Update snapshots with actual results. Snapshots will be created if missing.",
"type": "boolean"
},
"workers": {
"alias": "j",
"description": "Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker",
"type": "string"
}
},
"required": [],
"title": "Playwright executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/remix/src/generators/loader/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "data-loader",
"$schema": "https://json-schema.org/schema",
"description": "Generate an loader for a given route.",
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the loader in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | b3dd65adbc8ebd386ed0eddbd67fcdc1d8b3fa48 | 2023-03-22T21:38:32 | packages/angular/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookConfigurationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds Storybook configuration to a project to be able to use and create stories.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureCypress": {
"default": true,
"description": "Specifies whether to configure Cypress or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a Cypress e2e app to run against the storybook instance?"
},
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the generated Cypress e2e app?"
},
"generateStories": {
"default": true,
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"storybook7Configuration": {
"aliases": [
"storybook7betaConfiguration"
],
"default": false,
"description": "Configure your workspace using Storybook version 7.",
"hidden": true,
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean",
"x-priority": "important"
}
},
"required": [
"name"
],
"title": "Adds Storybook configuration to a project.",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nest/src/generators/class/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestClassGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Class Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18."
},
"language": {
"description": "Nest class language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the class.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Class Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/jest/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxJestInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Jest Configuration to a workspace.",
"properties": {
"babelJest": {
"alias": "babel-jest",
"default": false,
"description": "Use `babel-jest` instead of `ts-jest`.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Jest init",
"type": "object"
} | MIT | en |
nrwl/nx | b6cbb2ac6db6eec82e4b7db22fb2cf95f746baa3 | 2024-01-12T18:46:10 | packages/remix/src/generators/meta/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "meta",
"$schema": "http://json-schema.org/schema",
"description": "Generate a meta function for a given route.",
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the meta function in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | 7891a687153c596cce448ef30e8f28c7395d11b0 | 2022-08-17T11:06:07 | packages/angular/src/generators/scam-to-standalone/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularScamToStandalone",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Convert an Inline SCAM to a Standalone Component.",
"properties": {
"component": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The path to the SCAM component file, relative to the root of the project containing the SCAM.",
"type": "string"
},
"project": {
"description": "The project containing the SCAM.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What project contains the SCAM?"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean"
}
},
"title": "Convert an Inline SCAM to Standalone Component",
"type": "object"
} | MIT | en |
nrwl/nx | 79f5fc3108dead7f87011e41b3ad35656e2d579c | 2023-03-08T16:42:09 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "http://json-schema.org/schema",
"additionalProperties": true,
"cli": "nx",
"description": "Create an empty workspace.",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"defaultBase": {
"description": "Default base branch for affected.",
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"nxCloud": {
"default": false,
"description": "Connect the workspace to the free tier of the distributed cache provided by Nx Cloud.",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 1bc79652783bd5e47ad7e65025c359ea4be4c8fc | 2023-06-05T14:59:01 | packages/expo/src/executors/submit/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Submit app binary to App Store and/or Play Store.",
"presets": [
{
"keys": [
"platform"
],
"name": "Submit for a specific platform"
},
{
"keys": [
"profile"
],
"name": "Submit using a specific profile"
}
],
"properties": {
"id": {
"description": "Build ID to submit",
"type": "string"
},
"interactive": {
"default": true,
"description": "Run command in interactive mode",
"type": "boolean"
},
"latest": {
"description": "Submit the latest build for specified platform",
"type": "boolean"
},
"path": {
"description": "Path to the .apk/.aab/.ipa file",
"type": "string"
},
"platform": {
"alias": "p",
"description": "The platform to build the app, example values: ios, android, all.",
"enum": [
"ios",
"android",
"all"
],
"x-priority": "important"
},
"profile": {
"description": "Name of the build profile from eas.json. Defaults to \"production\" if defined in eas.json.",
"examples": [
"production",
"development",
"preview"
],
"type": "string",
"x-priority": "important"
},
"url": {
"description": "URL to the .apk/.aab/.ipa file, app archive url",
"type": "string"
},
"wait": {
"default": true,
"description": "Wait for build(s) to complete",
"type": "boolean"
}
},
"title": "EXPO EAS Submit Executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | d20cf91e6c5e1b71fb8af4e6413d27b15e82d2ce | 2023-01-13T16:50:01 | packages/react/src/generators/component-test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactCypressComponentTest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress component test for a component.",
"examples": [
{
"command": "nx g @nrwl/react:component-test --project=my-react-project --component-path=src/lib/fancy-component.tsx",
"description": "Create a cypress component test for FancyComponent"
}
],
"examplesFile": "../../../docs/component-test-examples.md",
"properties": {
"componentPath": {
"description": "Path to component, from the project source root",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the path to the component?"
},
"project": {
"description": "The name of the project the component is apart of",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project is this component apart of?"
}
},
"required": [
"project",
"componentPath"
],
"title": "Add Cypress component test",
"type": "object"
} | MIT | en |
nrwl/nx | 82fbb98e7d2337b801587e79c7e253056e0beee0 | 2022-12-21T14:15:26 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular application.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests. The `protractor` option is deprecated and it will be removed in v15.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Generate an application that is setup to use standalone components.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/eslint/src/generators/convert-to-flat-config/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "ConvertToFlatConfig",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Convert an Nx workspace's ESLint configs to use Flat Config.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/playwright/src/executors/playwright/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "https://json-schema.org/schema",
"description": "Run Playwright tests.",
"properties": {
"browser": {
"description": "Browser to use for tests, one of 'all', 'chromium', 'firefox' or 'webkit'. If a playwright config is provided/discovered then the browserName value is expected from the configured 'projects'",
"type": "string",
"x-priority": "important"
},
"config": {
"description": "Configuration file, or a test directory with optional",
"type": "string",
"x-completion-glob": "playwright?(*)@(.js|.cjs|.mjs|.ts|.cts|.mtx)",
"x-completion-type": "file",
"x-priority": "important"
},
"debug": {
"description": "Run tests with Playwright Inspector. Shortcut for 'PWDEBUG=1' environment variable and '--timeout=0',--max-failures=1 --headed --workers=1' options",
"type": "boolean"
},
"forbidOnly": {
"description": "Fail if test.only is called",
"type": "boolean"
},
"fullyParallel": {
"description": "Run all tests in parallel",
"type": "boolean"
},
"globalTimeout": {
"description": "Maximum time this test suite can run in milliseconds",
"type": "number"
},
"grep": {
"alias": "g",
"description": "Only run tests matching this regular expression",
"type": "string"
},
"grepInvert": {
"alias": "gv",
"description": "Only run tests that do not match this regular expression",
"type": "string"
},
"headed": {
"description": "Run tests in headed browsers",
"type": "boolean",
"x-priority": "important"
},
"ignoreSnapshots": {
"description": "Ignore screenshot and snapshot expectations",
"type": "boolean"
},
"list": {
"description": "Collect all the tests and report them, but do not run",
"type": "boolean"
},
"maxFailures": {
"alias": "x",
"description": "Stop after the first N failures",
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"noDeps": {
"description": "Do not run project dependencies",
"type": "boolean"
},
"output": {
"description": "Folder for output artifacts",
"type": "string"
},
"passWithNoTests": {
"default": true,
"description": "Makes test run succeed even if no tests were found",
"type": "boolean"
},
"project": {
"description": "Only run tests from the specified list of projects",
"items": {
"type": "string"
},
"type": "array"
},
"quiet": {
"alias": "q",
"description": "Suppress stdio",
"type": "boolean"
},
"repeatEach": {
"description": "Run each test N times",
"type": "number"
},
"reporter": {
"description": "Reporter to use, comma-separated, can be 'list', 'line', 'dot', 'json', 'junit', 'null', 'github', 'html', 'blob'. To configure reporter options, use the playwright configuration.",
"enum": [
"list",
"line",
"dot",
"json",
"junit",
"null",
"github",
"html",
"blob"
],
"type": "string"
},
"retries": {
"description": "Maximum retry count for flaky tests, zero for no retries",
"type": "number"
},
"shard": {
"description": "Shard tests and execute only the selected shard, specify in the form 'current/all', 1-based, for example '3/5'",
"type": "string"
},
"skipInstall": {
"default": false,
"description": "Skip running playwright install before running playwright tests. This is to ensure that playwright browsers are installed before running tests.",
"type": "boolean"
},
"testFiles": {
"alias": "t",
"description": "Test files to run",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Specify test timeout threshold in milliseconds, zero for unlimited",
"type": "number"
},
"trace": {
"description": "Force tracing mode, can be 'on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure'",
"enum": [
"on",
"off",
"on-first-retry",
"on-all-retries",
"retain-on-failure"
],
"type": "string"
},
"ui": {
"description": "Run tests in interactive UI mode",
"type": "boolean"
},
"uiHost": {
"description": "Host to serve UI on; specifying this option opens UI in a browser tab",
"type": "string"
},
"uiPort": {
"description": "Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab",
"type": "string"
},
"updateSnapshots": {
"alias": "u",
"description": "Update snapshots with actual results. Snapshots will be created if missing.",
"type": "boolean"
},
"workers": {
"alias": "j",
"description": "Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker",
"type": "string"
}
},
"required": [],
"title": "Playwright executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 18ddc74f4f7c0e3a22abdc44f868554d68830f6f | 2023-12-21T09:49:56 | packages/playwright/src/executors/playwright/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Run Playwright tests.",
"properties": {
"browser": {
"description": "Browser to use for tests, one of 'all', 'chromium', 'firefox' or 'webkit'. If a playwright config is provided/discovered then the browserName value is expected from the configured 'projects'",
"type": "string",
"x-priority": "important"
},
"config": {
"description": "Configuration file, or a test directory with optional",
"type": "string",
"x-completion-glob": "playwright?(*)@(.js|.cjs|.mjs|.ts|.cts|.mtx)",
"x-completion-type": "file",
"x-priority": "important"
},
"debug": {
"description": "Run tests with Playwright Inspector. Shortcut for 'PWDEBUG=1' environment variable and '--timeout=0',--max-failures=1 --headed --workers=1' options",
"type": "boolean"
},
"forbidOnly": {
"description": "Fail if test.only is called",
"type": "boolean"
},
"fullyParallel": {
"description": "Run all tests in parallel",
"type": "boolean"
},
"globalTimeout": {
"description": "Maximum time this test suite can run in milliseconds",
"type": "number"
},
"grep": {
"alias": "g",
"description": "Only run tests matching this regular expression",
"type": "string"
},
"grepInvert": {
"alias": "gv",
"description": "Only run tests that do not match this regular expression",
"type": "string"
},
"headed": {
"description": "Run tests in headed browsers",
"type": "boolean",
"x-priority": "important"
},
"ignoreSnapshots": {
"description": "Ignore screenshot and snapshot expectations",
"type": "boolean"
},
"list": {
"description": "Collect all the tests and report them, but do not run",
"type": "boolean"
},
"maxFailures": {
"alias": "x",
"description": "Stop after the first N failures",
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"noDeps": {
"description": "Do not run project dependencies",
"type": "boolean"
},
"output": {
"description": "Folder for output artifacts",
"type": "string"
},
"passWithNoTests": {
"default": true,
"description": "Makes test run succeed even if no tests were found",
"type": "boolean"
},
"project": {
"description": "Only run tests from the specified list of projects",
"items": {
"type": "string"
},
"type": "array"
},
"quiet": {
"alias": "q",
"description": "Suppress stdio",
"type": "boolean"
},
"repeatEach": {
"description": "Run each test N times",
"type": "number"
},
"reporter": {
"description": "Reporter to use, comma-separated, can be 'list', 'line', 'dot', 'json', 'junit', 'null', 'github', 'html', 'blob'. To configure reporter options, use the playwright configuration.",
"enum": [
"list",
"line",
"dot",
"json",
"junit",
"null",
"github",
"html",
"blob"
],
"type": "string"
},
"retries": {
"description": "Maximum retry count for flaky tests, zero for no retries",
"type": "number"
},
"shard": {
"description": "Shard tests and execute only the selected shard, specify in the form 'current/all', 1-based, for example '3/5'",
"type": "string"
},
"skipInstall": {
"default": false,
"description": "Skip running playwright install before running playwright tests. This is to ensure that playwright browsers are installed before running tests.",
"type": "boolean"
},
"testFiles": {
"alias": "t",
"description": "Test files to run",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Specify test timeout threshold in milliseconds, zero for unlimited",
"type": "number"
},
"trace": {
"description": "Force tracing mode, can be 'on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure'",
"enum": [
"on",
"off",
"on-first-retry",
"on-all-retries",
"retain-on-failure"
],
"type": "string"
},
"ui": {
"description": "Run tests in interactive UI mode",
"type": "boolean"
},
"uiHost": {
"description": "Host to serve UI on; specifying this option opens UI in a browser tab",
"type": "string"
},
"uiPort": {
"description": "Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab",
"type": "string"
},
"updateSnapshots": {
"alias": "u",
"description": "Update snapshots with actual results. Snapshots will be created if missing.",
"type": "boolean"
},
"workers": {
"alias": "j",
"description": "Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker",
"type": "string"
}
},
"required": [],
"title": "Playwright executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 2f7d647f52a2ab99aef880c0e0c9523ee51f3161 | 2022-09-27T17:03:23 | packages/react/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookStories",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a project.",
"examplesFile": "../../../docs/stories-examples.md",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `project` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-prompt": "For which project do you want to generate stories?"
}
},
"required": [
"project"
],
"title": "Generate React Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | 8154191eb1042b15ef2e477f6901b119009b07a9 | 2022-07-08T19:34:00 | packages/react/src/generators/component-test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactCypressComponentTest",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress component test for a component.",
"examples": [
{
"command": "nx g @nrwl/react:component-test --project=my-react-project --component-path=src/lib/fancy-component.tsx",
"description": "Create a cypress component test for FancyComponent"
}
],
"properties": {
"componentPath": {
"description": "Path to component, from the project source root",
"type": "string",
"x-prompt": "What is the path to the component?"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project the component is apart of",
"type": "string",
"x-prompt": "What project is this component apart of?"
}
},
"required": [
"project",
"componentPath"
],
"title": "Add Cypress component test",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/nest/src/generators/resolver/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestResolverGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Resolver Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"language": {
"description": "Nest resolver language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the resolver.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Resolver Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | edf0b1ce202a7175508f1412bb891a4b42a186bb | 2023-06-12T16:38:26 | packages/js/src/generators/setup-build/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SetupBuild",
"$schema": "http://json-schema.org/schema",
"description": "Sets up build target for a project.",
"properties": {
"buildTarget": {
"default": "build",
"description": "The build target to add.",
"type": "string"
},
"bundler": {
"default": "tsc",
"description": "The bundler to use to build the project.",
"enum": [
"tsc",
"swc",
"rollup",
"vite",
"esbuild"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler would you like to use to build the project?"
},
"main": {
"description": "The path to the main entry file, relative to workspace root. Defaults to <project>/src/index.ts or <project>/src/main.ts.",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Project to add the build target to.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "Which project do you want to add build to?"
},
"tsConfig": {
"description": "The path to the tsConfig file, relative to workspace root. Defaults to <project>/tsconfig.lib.json or <project>/tsconfig.app.json depending on project type.",
"type": "string"
}
},
"required": [
"project",
"bundler"
],
"title": "Setup Build",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixLibrary",
"$schema": "https://json-schema.org/schema",
"description": "Generate a Remix library to help structure workspace and application.",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Should the library be buildable?",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files after generator runs",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "Generate a stylesheet",
"enum": [
"none",
"css"
],
"type": "string"
},
"tags": {
"description": "Add tags to the library (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "vitest",
"description": "Test Runner to use for Unit Tests",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "What test runner should be used?"
}
},
"required": [
"name"
],
"title": "Create a Library",
"type": "object"
} | MIT | en |
nrwl/nx | a0904a601b1fd3a45ad0c51c626c372a420995c5 | 2022-09-07T13:32:19 | packages/angular/src/generators/component-test/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularComponentTestGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a `*.cy.ts` file for Cypress component testing for an Angular component.",
"properties": {
"componentDir": {
"description": "Relative path to the folder that contains the component from the project root.",
"example": [
"src/lib/my-fancy-button"
],
"type": "string"
},
"componentFileName": {
"description": "File name that contains the component without the `.ts` extension.",
"examples": [
"my-fancy-button.component"
],
"type": "string"
},
"componentName": {
"description": "Class name of the component to create a test for.",
"examples": [
"MyFancyButtonComponent"
],
"type": "string"
},
"project": {
"description": "The name of the project where the component is located.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What project is the component located in?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"projectPath",
"componentName",
"componentPath",
"componentFileName"
],
"type": "object"
} | MIT | en |
nrwl/nx | 4aa72822cdc474130ff481bfefa1d8ecdfbc96ae | 2022-09-08T08:44:31 | packages/angular/src/generators/setup-mf/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularMFSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given Angular Application.",
"properties": {
"appName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Module Federation configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate a Module Federation configuration for?"
},
"e2eProjectName": {
"description": "The project name of the associated E2E project for the application. This is only required for Cypress E2E projects that do not follow the naming convention `<appName>-e2e`.",
"type": "string"
},
"federationType": {
"default": "static",
"description": "Use either Static or Dynamic Module Federation pattern for the application.",
"enum": [
"static",
"dynamic"
],
"type": "string"
},
"host": {
"description": "The name of the host application that the remote application will be consumed by.",
"type": "string"
},
"mfType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"description": "The prefix to use for any generated component.",
"type": "string"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"routing": {
"description": "Generate a routing setup to allow a host application to route to the remote application.",
"type": "boolean"
},
"skipE2E": {
"default": false,
"description": "Do not set up E2E related config.",
"type": "boolean"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether the application is a standalone application.",
"type": "boolean"
}
},
"required": [
"appName",
"mfType"
],
"title": "Generate Module Federation Setup for Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | 4df3b661528656d81e5deaf603af2dbc25b9dce9 | 2021-03-11T19:18:22 | packages/node/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "SchematicsNxNodeApp",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to package.json.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 047dc22aed99ee0870357fa1508cd5decb8009a7 | 2024-01-16T14:29:44 | packages/web/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Init Web Plugin.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Init Web Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 72b0f5560567ba0f7cdcffea754a47ae6753d77a | 2023-05-31T12:37:24 | packages/js/src/executors/verdaccio/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Start a local registry with Verdaccio.",
"properties": {
"clear": {
"default": true,
"description": "Clear local registry storage before starting Verdaccio",
"type": "boolean"
},
"config": {
"description": "Path to the custom Verdaccio config file",
"type": "string"
},
"location": {
"default": "user",
"description": "Location option for npm config",
"enum": [
"global",
"user",
"project",
"none"
],
"type": "string"
},
"port": {
"default": 4873,
"description": "Port of local registry that Verdaccio should listen to",
"type": "number"
},
"storage": {
"description": "Path to the custom storage directory for Verdaccio",
"type": "string"
}
},
"required": [
"port"
],
"title": "Verdaccio Local Registry",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | a9ac43b86f7804883d9e97bceac38f8bb40a4c26 | 2022-11-30T04:20:27 | packages/react/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNgInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initialize a React Plugin.",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified E2E test runner.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipBabelConfig": {
"default": false,
"description": "Do not generate a root babel.config.json (if babel is not needed).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipHelperLibs": {
"default": false,
"description": "Do not install helpers libs (tslib, core-js, regenerator-runtime).",
"hidden": true,
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init React Plugin",
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 514a1132b6fde686bf6a8f2d678ac0cc667bbb35 | 2023-01-27T13:08:12 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "/test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref",
"target"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 75a777262f8741c9f62079f793b89f693bd50fb7 | 2023-02-20T09:09:46 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$defs": {
"test": {
"$anchor": "test",
"oneOf": [
{
"description": "A test with an expected result to the reference lookup.",
"required": [
"target"
]
},
{
"description": "A test with some form of invalid reference. How this is reported will be language-specific.",
"required": [
"error"
]
}
],
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"error": {
"const": true
},
"ref": {
"type": "string"
},
"target": {},
"then": {
"$ref": "#test",
"properties": {
"base_uri": false
},
"title": "A further test to run which should maintain state from the initial lookup."
}
},
"required": [
"ref"
],
"type": "object",
"unevaluatedProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "\\.\\./\\.\\./test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"description": "A collection of schemas, identified by (retrieval) URI which may be referenced in tests in this file.",
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"$ref": "#test"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | abbeb5fc4964130235d8d8b99c67d39986ab0243 | 2023-02-20T08:37:37 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "\\.\\./\\.\\./test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"description": "A collection of schemas, identified by (retrieval) URI which may be referenced in tests in this file.",
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"oneOf": [
{
"description": "A test with an expected result to the reference lookup.",
"required": [
"target"
]
},
{
"description": "A test with some form of invalid reference. How this is reported will be language-specific.",
"required": [
"error"
]
}
],
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"error": {
"const": true
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref"
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 599442240c7931ee319e5ce03de1c450bd2ff7cf | 2023-01-10T20:33:31 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"registry": {
"default": {},
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref",
"target"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | e19b2b6e576d9903403f24812c61805b95b668f1 | 2023-02-19T15:30:20 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "\\.\\./\\.\\./test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"description": "A collection of schemas, identified by (retrieval) URI which may be referenced in tests in this file.",
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"minItems": 1,
"oneOf": [
{
"description": "A test with an expected result to the reference lookup.",
"required": [
"target"
]
},
{
"description": "A test with some form of invalid reference. How this is reported will be language-specific.",
"required": [
"error"
]
}
],
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"error": {
"const": true
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref"
],
"type": "object",
"unevaluatedProperties": false,
"uniqueItems": true
},
"type": "array"
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 06bc9d63789a2f455bfccbef5c60718bae80696a | 2023-01-27T14:08:42 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "/test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"description": "A collection of schemas, identified by (retrieval) URI which may be referenced in tests in this file.",
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"oneOf": [
{
"description": "A test with an expected result to the reference lookup.",
"required": [
"target"
]
},
{
"description": "A test with some form of invalid reference. How this is reported will be language-specific.",
"required": [
"error"
]
}
],
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"error": {
"const": true
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref"
],
"type": "object",
"unevaluatedProperties": false
},
"type": "array"
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 0ba3ce7970a87f2023a303596950da49f3c895f4 | 2023-11-08T16:05:34 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$defs": {
"test": {
"$anchor": "test",
"oneOf": [
{
"description": "A test with an expected result to the reference lookup.",
"required": [
"target"
]
},
{
"description": "A test with some form of invalid reference. How this is reported will be language-specific.",
"required": [
"error"
]
}
],
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"error": {
"const": true
},
"ref": {
"type": "string"
},
"target": {},
"then": {
"$ref": "#test",
"properties": {
"base_uri": false
},
"title": "A further test to run which should maintain state from the initial lookup."
},
"why": {
"description": "A human-readable explanation of the results of this test.",
"properties": {
"specifications": {
"description": "One or more releavnt specifications for this test.",
"items": {
"oneOf": [
{
"required": [
"rfc"
]
},
{
"required": [
"name"
]
}
],
"properties": {
"link": {
"format": "uri",
"type": "string"
},
"name": {
"description": "Any other specification",
"type": "string"
},
"rfc": {
"description": "An IETF RFC",
"type": "number"
},
"section": {
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"summary": {
"description": "A summary of the behavior specified in the linked specifications",
"type": "string"
}
},
"type": "object",
"unevaluatedProperties": false
}
},
"required": [
"ref"
],
"type": "object",
"unevaluatedProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "\\.\\./\\.\\./test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"description": "A collection of schemas, identified by (retrieval) URI which may be referenced in tests in this file.",
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"$ref": "#test"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 8fdc14db9c20f193d82018dd4ea6ae3591e5196f | 2023-01-26T22:37:07 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "/test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref",
"target",
"$schema"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
python-jsonschema/referencing-suite | 6d9716e90a93b52bad705479d2c07d3de4264fe4 | 2023-02-19T15:28:30 | test-schema.json | 8 | 2024-05-27T06:31:24.404485Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for files contained within this suite",
"properties": {
"$schema": {
"pattern": "/test-schema.json$",
"type": "string"
},
"registry": {
"default": {},
"description": "A collection of schemas, identified by (retrieval) URI which may be referenced in tests in this file.",
"propertyNames": {
"format": "uri-reference"
},
"type": "object"
},
"tests": {
"items": {
"minItems": 1,
"oneOf": [
{
"description": "A test with an expected result to the reference lookup.",
"required": [
"target"
]
},
{
"description": "A test with some form of invalid reference. How this is reported will be language-specific.",
"required": [
"error"
]
}
],
"properties": {
"base_uri": {
"format": "uri",
"type": "string"
},
"error": {
"const": true
},
"ref": {
"type": "string"
},
"target": {}
},
"required": [
"ref"
],
"type": "object",
"unevaluatedProperties": false,
"uniqueItems": true
},
"type": "array"
}
},
"required": [
"$schema",
"tests"
],
"type": "object"
} | MIT | en |
python-jsonschema/jsonschema | 3f58e36754b3e2872a256874c1ffdd30c677f709 | 2020-06-09T23:00:09 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
},
"test": {
"additionalProperties": false,
"description": "A single test",
"properties": {
"comment": {
"description": "Any additional comments about the test",
"type": "string"
},
"data": {
"description": "This is the instance to be validated against the schema in \"schema\"."
},
"description": {
"description": "The test description",
"type": "string"
},
"id": {
"description": "Uniquely identifies a single test",
"format": "uri",
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
}
},
"description": "Schema for tests",
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"comment": {
"description": "Any additional comments about the test set",
"type": "string"
},
"description": {
"description": "The test set description",
"type": "string"
},
"id": {
"description": "Uniquely identifies a set of tests",
"format": "uri",
"type": "string"
},
"schema": {
"description": "This should be a valid schema. This should be a ref to a meta-schema if schema keywords need testing."
},
"tests": {
"description": "A set of related tests all using the same schema",
"items": {
"$ref": "#/definitions/test"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | afc22f09e74d696ab00be8a711bbc5c2a15327b7 | 2022-06-30T21:16:21 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$defs": {
"test": {
"additionalProperties": false,
"description": "A single test",
"properties": {
"comment": {
"description": "Any additional comments about the test",
"type": "string"
},
"data": {
"description": "The instance which should be validated against the schema in \"schema\"."
},
"description": {
"description": "The test description, briefly explaining which behavior it exercises",
"type": "string"
},
"valid": {
"description": "Whether the validation process of this instance should consider the instance valid or not",
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A schema for files contained within this suite",
"items": {
"additionalProperties": false,
"description": "An individual test case, containing multiple tests of a single schema's behavior",
"properties": {
"comment": {
"description": "Any additional comments about the test case",
"type": "string"
},
"description": {
"description": "The test case description",
"type": "string"
},
"schema": {
"description": "A valid JSON Schema (one written for the corresponding version directory that the file sits within)."
},
"tests": {
"description": "A set of related tests all using the same schema",
"items": {
"$ref": "#/$defs/test"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"minItems": 1,
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | a39ed5a8254f01e9c5e9c38daac965adb54847a3 | 2019-07-26T11:37:24 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
}
},
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"description": {
"type": "string"
},
"schema": {},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"data": {},
"description": {
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | 76319885005152f600a13c058011ceae3dbea196 | 2020-03-21T19:12:50 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
}
},
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"description": {
"type": "string"
},
"schema": {},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"data": {},
"description": {
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | 4502eb6483e9af6ffdcec2021a7dd2fbbd0f0785 | 2020-04-29T11:35:22 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
},
"test": {
"additionalProperties": false,
"description": "A single test",
"properties": {
"data": {},
"description": {
"type": "string"
},
"id": {
"description": "Uniquely identifies a single test",
"format": "uri",
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
}
},
"description": "Schema for tests",
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "Uniquely identifies a set of tests",
"format": "uri",
"type": "string"
},
"schema": {
"description": "This should be a valid schema. This should be a ref to a meta-schema if schema keywords need testing."
},
"tests": {
"description": "A set of related tests all using the same schema",
"items": {
"$ref": "#/definitions/test"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | a11cdd338fc56e901c066f4a0790d22d725e0c82 | 2017-06-10T16:01:14 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"description": {
"type": "string"
},
"schema": {},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"data": {},
"description": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | 0dd4b1c2f4dc2ce3cf083bfa339a517993ec68d5 | 2020-04-28T13:45:15 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
},
"test": {
"additionalProperties": false,
"description": "A single test",
"properties": {
"data": {},
"description": {
"type": "string"
},
"id": {
"description": "Uniquely identifies a single test",
"format": "uri",
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
}
},
"description": "Schema for tests",
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "Uniquely identifies a set of tests",
"format": "uri",
"type": "string"
},
"schema": {},
"tests": {
"description": "A set of related tests all using the same schema",
"items": {
"$ref": "#/definitions/test"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | 5e71e05cb141b537c6dd9dcd5c748d6046e02d9e | 2020-03-23T19:26:26 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
}
},
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"description": {
"type": "string"
},
"schema": {},
"tests": {
"items": {
"additionalProperties": false,
"properties": {
"data": {},
"description": {
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
python-jsonschema/jsonschema | 1fae89b3cec5c018e86a8aa14f394543fd18d2d6 | 2020-05-02T20:04:17 | json/test-schema.json | 4,468 | 2024-05-29T09:19:31.928784Z | {
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"outputItem": {
"properties": {
"absoluteKeywordLocation": {
"format": "uri",
"type": "string"
},
"annotations": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"errors": {
"items": {
"$ref": "#/definitions/outputItem"
},
"type": "array"
},
"instanceLocation": {
"type": "string"
},
"keywordLocation": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"type": "object"
},
"test": {
"additionalProperties": false,
"description": "A single test",
"properties": {
"comment": {
"description": "Any additional comments about the test",
"type": "string"
},
"data": {},
"description": {
"description": "The test description",
"type": "string"
},
"id": {
"description": "Uniquely identifies a single test",
"format": "uri",
"type": "string"
},
"output": {
"properties": {
"basic": {
"$ref": "#/definitions/outputItem"
},
"detailed": {
"$ref": "#/definitions/outputItem"
},
"verbose": {
"$ref": "#/definitions/outputItem"
}
},
"required": [
"basic",
"detailed",
"verbose"
],
"type": "object"
},
"valid": {
"type": "boolean"
}
},
"required": [
"description",
"data",
"valid"
],
"type": "object"
}
},
"description": "Schema for tests",
"items": {
"additionalProperties": false,
"minItems": 1,
"properties": {
"comment": {
"description": "Any additional comments about the test set",
"type": "string"
},
"description": {
"description": "The test set description",
"type": "string"
},
"id": {
"description": "Uniquely identifies a set of tests",
"format": "uri",
"type": "string"
},
"schema": {
"description": "This should be a valid schema. This should be a ref to a meta-schema if schema keywords need testing."
},
"tests": {
"description": "A set of related tests all using the same schema",
"items": {
"$ref": "#/definitions/test"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"description",
"schema",
"tests"
],
"type": "object"
},
"type": "array"
} | MIT | en |
jskherman/cv.typ | 405290b0e1ba45f338465c462e95d0c2905d7445 | 2023-11-15T16:24:05 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"default": {},
"examples": [
{
"affiliations": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"awards": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"certificates": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"education": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"interests": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"languages": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"personal": {
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
},
"projects": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"publications": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"references": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"skills": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"work": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
}
],
"properties": {
"affiliations": {
"default": [],
"examples": [
[
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
]
],
"items": {
"examples": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"properties": {
"endDate": {
"examples": [
"2021-05-30",
"2023-06-30"
],
"format": "date",
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
[
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
]
],
"items": {
"examples": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?",
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Cambridge, United Kingdom",
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"White Hat Hackers Association",
"London Bridge Toastmasters Club"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Vice President for Internal Affairs",
"Member"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2020-05-30",
"2022-06-15"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com",
""
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The affiliations Schema",
"type": "array"
},
"awards": {
"default": [],
"examples": [
[
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
]
],
"items": {
"examples": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"properties": {
"date": {
"examples": [
"2023-05-09",
"2020-07-12"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"highlights": {
"examples": [
null,
[
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
]
],
"items": {
"examples": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"null",
"array"
]
},
"issuer": {
"examples": [
"Toastmasters International",
"Sasin School of Management"
],
"title": "The issuer Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom",
"Bangkok, Thailand"
],
"title": "The location Schema",
"type": "string"
},
"title": {
"examples": [
"Champion in the Division A District X Speech Evaluation Contest",
"Finalist in the 2020 SCG Bangkok Business Challenge Global Competition"
],
"title": "The title Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"title",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The awards Schema",
"type": "array"
},
"certificates": {
"default": [],
"examples": [
[
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"properties": {
"date": {
"default": "",
"examples": [
"2021-09-01"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"issuer": {
"default": "",
"examples": [
"Coursera"
],
"title": "The issuer Schema",
"type": "string"
},
"name": {
"default": "",
"examples": [
"Learning How to Learn: Powerful mental tools to help you master tough subjects"
],
"title": "The name Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The certificates Schema",
"type": [
"array",
"null"
]
},
"education": {
"default": [],
"examples": [
[
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
]
],
"items": {
"examples": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"properties": {
"area": {
"examples": [
"Computer Science"
],
"title": "The area Schema",
"type": "string"
},
"courses": {
"examples": [
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
]
],
"items": {
"examples": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"title": "A Schema",
"type": "string"
},
"title": "The courses Schema",
"type": [
"array",
"null"
]
},
"endDate": {
"examples": [
"2021-06-30"
],
"format": "date",
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
]
],
"items": {
"examples": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"honors": {
"examples": [
[
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
[
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
]
],
"items": {
"examples": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List",
"Summa Cum Laude (4.0 GPA)"
],
"title": "A Schema",
"type": "string"
},
"title": "The honors Schema",
"type": [
"array",
"null"
]
},
"institution": {
"examples": [
"Open University",
"Harvard University"
],
"title": "The institution Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"startDate": {
"examples": [
"2017-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"studyType": {
"examples": [
"Bachelor of Science"
],
"title": "The studyType Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"area",
"studyType",
"startDate",
"endDate",
"location",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The education Schema",
"type": "array"
},
"interests": {
"default": [],
"examples": [
[
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
]
],
"items": {
"examples": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"title": "A Schema",
"type": "string"
},
"title": "The interests Schema",
"type": "array"
},
"languages": {
"default": [],
"examples": [
[
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
]
],
"items": {
"examples": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"properties": {
"fluency": {
"examples": [
"Native speaker",
"Basic proficiency"
],
"title": "The fluency Schema",
"type": "string"
},
"language": {
"examples": [
"English",
"German",
"Japanese"
],
"title": "The language Schema",
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"title": "A Schema",
"type": "object"
},
"title": "The languages Schema",
"type": "array"
},
"personal": {
"default": {},
"examples": [
{
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
}
],
"properties": {
"email": {
"default": "",
"examples": [
"[email protected]"
],
"format": "email",
"title": "The email Schema",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"examples": [
{
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
}
],
"properties": {
"city": {
"default": "",
"examples": [
"New York"
],
"title": "The city Schema",
"type": "string"
},
"country": {
"default": "",
"examples": [
"United States of America"
],
"title": "The country Schema",
"type": "string"
},
"postalCode": {
"default": 0,
"examples": [
1234
],
"title": "The postalCode Schema",
"type": "integer"
},
"region": {
"default": "",
"examples": [
"New York"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"title": "The location Schema",
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"examples": [
"John Smith L. Doe"
],
"title": "The name Schema",
"type": "string"
},
"phone": {
"default": "",
"examples": [
"(+1) 987 6543 210"
],
"title": "The phone Schema",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"examples": [
[
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
]
],
"items": {
"examples": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"properties": {
"network": {
"examples": [
"LinkedIn",
"GitHub"
],
"title": "The network Schema",
"type": "string"
},
"url": {
"examples": [
"https://linkedin.com/in/johndoe",
"https://github.com/johndoe"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
},
"username": {
"examples": [
"John Doe",
"johndoe"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The profiles Schema",
"type": "array"
},
"url": {
"default": "",
"examples": [
"https://johndoe.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"title": "The personal Schema",
"type": "object"
},
"projects": {
"default": [],
"examples": [
[
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
]
],
"items": {
"default": {},
"examples": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"properties": {
"affiliation": {
"default": "",
"examples": [
"Open University"
],
"title": "The affiliation Schema",
"type": "string"
},
"endDate": {
"default": "",
"examples": [
"2021-04-30"
],
"format": "date",
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"default": [],
"examples": [
[
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
]
],
"items": {
"examples": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": "array"
},
"name": {
"default": "",
"examples": [
"Job Tailor"
],
"title": "The name Schema",
"type": "string"
},
"startDate": {
"default": "",
"examples": [
"2020-11-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The projects Schema",
"type": [
"array",
"null"
]
},
"publications": {
"default": [],
"examples": [
[
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"A convolutional neural network for predicting Greenland glacier melt and glacial water flow"
],
"title": "The name Schema",
"type": "string"
},
"publisher": {
"default": "",
"examples": [
"Theoretical and Computational Fluid Dynamics"
],
"title": "The publisher Schema",
"type": "string"
},
"releaseDate": {
"default": "",
"examples": [
"2020-09-30"
],
"format": "date",
"title": "The releaseDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The publications Schema",
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"examples": [
[
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"Dr. Jane Austin"
],
"title": "The name Schema",
"type": "string"
},
"reference": {
"default": "",
"examples": [
"John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition."
],
"title": "The reference Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://janeaustin.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"title": "A Schema",
"type": "object"
},
"title": "The references Schema",
"type": [
"array",
"null"
]
},
"skills": {
"default": [],
"examples": [
[
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
]
],
"items": {
"examples": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"properties": {
"category": {
"examples": [
"Soft Skills",
"Programming",
"Tools",
"Web Development",
"BI & Data Analytics"
],
"title": "The category Schema",
"type": "string"
},
"skills": {
"examples": [
[
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
],
[
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
],
[
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
],
[
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
],
[
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
],
"items": {
"examples": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing",
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX",
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva",
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask",
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
],
"title": "A Schema",
"type": "string"
},
"title": "The skills Schema",
"type": "array"
}
},
"required": [
"category",
"skills"
],
"title": "A Schema",
"type": "object"
},
"title": "The skills Schema",
"type": "array"
},
"work": {
"default": [],
"examples": [
[
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
],
"items": {
"examples": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
],
"properties": {
"endDate": {
"examples": [
"present",
"2023-05-31"
],
"format": "date",
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
]
],
"items": {
"examples": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Remote / New York, New York",
"Pasadena, California"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"X Company",
"National Aeronautics and Space Administration - Jet Propulsion Laboratory"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Senior Developer"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2021-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The work Schema",
"type": "array"
}
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | a5f7cf245bf4a554dcfd455c3d2adadf6948616e | 2024-01-22T12:30:13 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"default": {},
"properties": {
"affiliations": {
"default": [],
"items": {
"properties": {
"endDate": {
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"title": "The location Schema",
"type": "string"
},
"organization": {
"title": "The organization Schema",
"type": "string"
},
"position": {
"title": "The position Schema",
"type": "string"
},
"startDate": {
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The affiliations Schema",
"type": "array"
},
"awards": {
"default": [],
"items": {
"properties": {
"date": {
"format": "date",
"title": "The date Schema",
"type": "string"
},
"highlights": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"null",
"array"
]
},
"issuer": {
"title": "The issuer Schema",
"type": "string"
},
"location": {
"title": "The location Schema",
"type": "string"
},
"title": {
"title": "The title Schema",
"type": "string"
},
"url": {
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The awards Schema",
"type": "array"
},
"certificates": {
"default": [],
"items": {
"default": {},
"properties": {
"date": {
"default": "",
"format": "date",
"title": "The date Schema",
"type": "string"
},
"issuer": {
"default": "",
"title": "The issuer Schema",
"type": "string"
},
"name": {
"default": "",
"title": "The name Schema",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The certificates Schema",
"type": [
"array",
"null"
]
},
"education": {
"default": [],
"items": {
"properties": {
"area": {
"title": "The area Schema",
"type": "string"
},
"courses": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The courses Schema",
"type": [
"array",
"null"
]
},
"endDate": {
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"honors": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The honors Schema",
"type": [
"array",
"null"
]
},
"institution": {
"title": "The institution Schema",
"type": "string"
},
"location": {
"title": "The location Schema",
"type": "string"
},
"startDate": {
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"studyType": {
"title": "The studyType Schema",
"type": "string"
},
"url": {
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"area",
"studyType",
"startDate",
"endDate",
"location",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The education Schema",
"type": "array"
},
"interests": {
"default": [],
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The interests Schema",
"type": "array"
},
"languages": {
"default": [],
"items": {
"properties": {
"fluency": {
"title": "The fluency Schema",
"type": "string"
},
"language": {
"title": "The language Schema",
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"title": "A Schema",
"type": "object"
},
"title": "The languages Schema",
"type": "array"
},
"personal": {
"default": {},
"properties": {
"email": {
"default": "",
"format": "email",
"title": "The email Schema",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"properties": {
"city": {
"default": "",
"title": "The city Schema",
"type": "string"
},
"country": {
"default": "",
"title": "The country Schema",
"type": "string"
},
"postalCode": {
"default": 0,
"title": "The postalCode Schema",
"type": "integer"
},
"region": {
"default": "",
"title": "The region Schema",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"title": "The location Schema",
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"title": "The name Schema",
"type": "string"
},
"phone": {
"default": "",
"title": "The phone Schema",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"items": {
"properties": {
"network": {
"title": "The network Schema",
"type": "string"
},
"url": {
"format": "uri",
"title": "The url Schema",
"type": "string"
},
"username": {
"title": "The username Schema",
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The profiles Schema",
"type": "array"
},
"url": {
"default": "",
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"title": "The personal Schema",
"type": "object"
},
"projects": {
"default": [],
"items": {
"default": {},
"properties": {
"affiliation": {
"default": "",
"title": "The affiliation Schema",
"type": "string"
},
"endDate": {
"default": "",
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"default": [],
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": "array"
},
"name": {
"default": "",
"title": "The name Schema",
"type": "string"
},
"startDate": {
"default": "",
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The projects Schema",
"type": [
"array",
"null"
]
},
"publications": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"title": "The name Schema",
"type": "string"
},
"publisher": {
"default": "",
"title": "The publisher Schema",
"type": "string"
},
"releaseDate": {
"default": "",
"format": "date",
"title": "The releaseDate Schema",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The publications Schema",
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"title": "The name Schema",
"type": "string"
},
"reference": {
"default": "",
"title": "The reference Schema",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"title": "A Schema",
"type": "object"
},
"title": "The references Schema",
"type": [
"array",
"null"
]
},
"skills": {
"default": [],
"items": {
"properties": {
"category": {
"title": "The category Schema",
"type": "string"
},
"skills": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The skills Schema",
"type": "array"
}
},
"required": [
"category",
"skills"
],
"title": "A Schema",
"type": "object"
},
"title": "The skills Schema",
"type": "array"
},
"work": {
"default": [],
"items": {
"properties": {
"endDate": {
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"items": {
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"title": "The location Schema",
"type": "string"
},
"organization": {
"title": "The organization Schema",
"type": "string"
},
"position": {
"title": "The position Schema",
"type": "string"
},
"startDate": {
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The work Schema",
"type": "array"
}
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | 745936bb28e5cee54d4f94996ad1e109ccab50b2 | 2023-11-25T14:23:37 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"default": {},
"examples": [
{
"affiliations": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"awards": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"certificates": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"education": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"interests": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"languages": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"personal": {
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
},
"projects": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"publications": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"references": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"skills": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"work": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
}
],
"properties": {
"affiliations": {
"default": [],
"examples": [
[
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
]
],
"items": {
"examples": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"properties": {
"endDate": {
"examples": [
"2021-05-30",
"2023-06-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
[
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
]
],
"items": {
"examples": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?",
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Cambridge, United Kingdom",
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"White Hat Hackers Association",
"London Bridge Toastmasters Club"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Vice President for Internal Affairs",
"Member"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2020-05-30",
"2022-06-15"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com",
""
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The affiliations Schema",
"type": "array"
},
"awards": {
"default": [],
"examples": [
[
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
]
],
"items": {
"examples": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"properties": {
"date": {
"examples": [
"2023-05-09",
"2020-07-12"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"highlights": {
"examples": [
null,
[
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
]
],
"items": {
"examples": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"null",
"array"
]
},
"issuer": {
"examples": [
"Toastmasters International",
"Sasin School of Management"
],
"title": "The issuer Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom",
"Bangkok, Thailand"
],
"title": "The location Schema",
"type": "string"
},
"title": {
"examples": [
"Champion in the Division A District X Speech Evaluation Contest",
"Finalist in the 2020 SCG Bangkok Business Challenge Global Competition"
],
"title": "The title Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The awards Schema",
"type": "array"
},
"certificates": {
"default": [],
"examples": [
[
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"properties": {
"date": {
"default": "",
"examples": [
"2021-09-01"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"issuer": {
"default": "",
"examples": [
"Coursera"
],
"title": "The issuer Schema",
"type": "string"
},
"name": {
"default": "",
"examples": [
"Learning How to Learn: Powerful mental tools to help you master tough subjects"
],
"title": "The name Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The certificates Schema",
"type": [
"array",
"null"
]
},
"education": {
"default": [],
"examples": [
[
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
]
],
"items": {
"examples": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"properties": {
"area": {
"examples": [
"Computer Science"
],
"title": "The area Schema",
"type": "string"
},
"courses": {
"examples": [
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
]
],
"items": {
"examples": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"title": "A Schema",
"type": "string"
},
"title": "The courses Schema",
"type": [
"array",
"null"
]
},
"endDate": {
"examples": [
"2021-06-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
]
],
"items": {
"examples": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activities*: Debating, Chess, Cricket"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"honors": {
"examples": [
[
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
[
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
]
],
"items": {
"examples": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List",
"Summa Cum Laude (4.0 GPA)"
],
"title": "A Schema",
"type": "string"
},
"title": "The honors Schema",
"type": [
"array",
"null"
]
},
"institution": {
"examples": [
"Open University",
"Harvard University"
],
"title": "The institution Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"startDate": {
"examples": [
"2017-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"studyType": {
"examples": [
"Bachelor of Science"
],
"title": "The studyType Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"area",
"studyType",
"startDate",
"endDate",
"location",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The education Schema",
"type": "array"
},
"interests": {
"default": [],
"examples": [
[
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
]
],
"items": {
"examples": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"title": "A Schema",
"type": "string"
},
"title": "The interests Schema",
"type": "array"
},
"languages": {
"default": [],
"examples": [
[
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
]
],
"items": {
"examples": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"properties": {
"fluency": {
"examples": [
"Native speaker",
"Basic proficiency"
],
"title": "The fluency Schema",
"type": "string"
},
"language": {
"examples": [
"English",
"German",
"Japanese"
],
"title": "The language Schema",
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"title": "A Schema",
"type": "object"
},
"title": "The languages Schema",
"type": "array"
},
"personal": {
"default": {},
"examples": [
{
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
}
],
"properties": {
"email": {
"default": "",
"examples": [
"[email protected]"
],
"format": "email",
"title": "The email Schema",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"examples": [
{
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
}
],
"properties": {
"city": {
"default": "",
"examples": [
"New York"
],
"title": "The city Schema",
"type": "string"
},
"country": {
"default": "",
"examples": [
"United States of America"
],
"title": "The country Schema",
"type": "string"
},
"postalCode": {
"default": 0,
"examples": [
1234
],
"title": "The postalCode Schema",
"type": "integer"
},
"region": {
"default": "",
"examples": [
"New York"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"title": "The location Schema",
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"examples": [
"John Smith L. Doe"
],
"title": "The name Schema",
"type": "string"
},
"phone": {
"default": "",
"examples": [
"(+1) 987 6543 210"
],
"title": "The phone Schema",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"examples": [
[
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
]
],
"items": {
"examples": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"properties": {
"network": {
"examples": [
"LinkedIn",
"GitHub"
],
"title": "The network Schema",
"type": "string"
},
"url": {
"examples": [
"https://linkedin.com/in/johndoe",
"https://github.com/johndoe"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
},
"username": {
"examples": [
"John Doe",
"johndoe"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The profiles Schema",
"type": "array"
},
"url": {
"default": "",
"examples": [
"https://johndoe.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"title": "The personal Schema",
"type": "object"
},
"projects": {
"default": [],
"examples": [
[
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
]
],
"items": {
"default": {},
"examples": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"properties": {
"affiliation": {
"default": "",
"examples": [
"Open University"
],
"title": "The affiliation Schema",
"type": "string"
},
"endDate": {
"default": "",
"examples": [
"2021-04-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"default": [],
"examples": [
[
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
]
],
"items": {
"examples": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": "array"
},
"name": {
"default": "",
"examples": [
"Job Tailor"
],
"title": "The name Schema",
"type": "string"
},
"startDate": {
"default": "",
"examples": [
"2020-11-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The projects Schema",
"type": [
"array",
"null"
]
},
"publications": {
"default": [],
"examples": [
[
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"A convolutional neural network for predicting Greenland glacier melt and glacial water flow"
],
"title": "The name Schema",
"type": "string"
},
"publisher": {
"default": "",
"examples": [
"Theoretical and Computational Fluid Dynamics"
],
"title": "The publisher Schema",
"type": "string"
},
"releaseDate": {
"default": "",
"examples": [
"2020-09-30"
],
"format": "date",
"title": "The releaseDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The publications Schema",
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"examples": [
[
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"Dr. Jane Austin"
],
"title": "The name Schema",
"type": "string"
},
"reference": {
"default": "",
"examples": [
"John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition."
],
"title": "The reference Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://janeaustin.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"title": "A Schema",
"type": "object"
},
"title": "The references Schema",
"type": [
"array",
"null"
]
},
"skills": {
"default": [],
"examples": [
[
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
]
],
"items": {
"examples": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"properties": {
"category": {
"examples": [
"Soft Skills",
"Programming",
"Tools",
"Web Development",
"BI & Data Analytics"
],
"title": "The category Schema",
"type": "string"
},
"skills": {
"examples": [
[
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
],
[
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
],
[
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
],
[
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
],
[
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
],
"items": {
"examples": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing",
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX",
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva",
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask",
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
],
"title": "A Schema",
"type": "string"
},
"title": "The skills Schema",
"type": "array"
}
},
"required": [
"category",
"skills"
],
"title": "A Schema",
"type": "object"
},
"title": "The skills Schema",
"type": "array"
},
"work": {
"default": [],
"examples": [
[
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
],
"items": {
"examples": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
],
"properties": {
"endDate": {
"examples": [
"present",
"2023-05-31"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
]
],
"items": {
"examples": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Remote / New York, New York",
"Pasadena, California"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"X Company",
"National Aeronautics and Space Administration - Jet Propulsion Laboratory"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Senior Developer"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2021-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The work Schema",
"type": "array"
}
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | b60c50852092c23674f0e32dd2196a03c44cf862 | 2023-09-15T06:37:53 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Schema for the @jskherman's Curriculum Vitae YAML-Typst Template",
"properties": {
"affiliations": {
"items": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"organization",
"position",
"location",
"url",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"awards": {
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"type": "string"
},
"location": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"title",
"date",
"issuer",
"url",
"location",
"highlights"
],
"type": "object"
},
"type": "array"
},
"certificates": {
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"issuer": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer",
"url"
],
"type": "object"
},
"type": "array"
},
"education": {
"items": {
"properties": {
"area": {
"type": "string"
},
"courses": {
"items": {
"type": "string"
},
"type": "array"
},
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"honors": {
"items": {
"type": "string"
},
"type": "array"
},
"institution": {
"type": "string"
},
"location": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"studyType": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"institution",
"url",
"area",
"studyType",
"startDate",
"endDate",
"location",
"honors",
"courses",
"highlights"
],
"type": "object"
},
"type": "array"
},
"interests": {
"items": {
"type": "string"
},
"type": "array"
},
"languages": {
"items": {
"properties": {
"fluency": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"type": "object"
},
"type": "array"
},
"personal": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"location": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": [
"integer",
"string"
]
},
"region": {
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"type": "object"
},
"name": {
"type": "string"
},
"phone": {
"type": "string"
},
"profiles": {
"items": {
"properties": {
"network": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"type": "object"
},
"type": "array"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"email",
"phone",
"url",
"location",
"profiles"
],
"type": "object"
},
"projects": {
"items": {
"properties": {
"affiliation": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"publications": {
"items": {
"properties": {
"name": {
"type": "string"
},
"publisher": {
"type": "string"
},
"releaseDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"type": "object"
},
"type": "array"
},
"references": {
"items": {
"properties": {
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"reference",
"url"
],
"type": "object"
},
"type": "array"
},
"skills": {
"items": {
"properties": {
"category": {
"type": "string"
},
"skills": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"category",
"skills"
],
"type": "object"
},
"type": "array"
},
"work": {
"items": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"organization",
"position",
"url",
"location",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"personal",
"work",
"education",
"affiliations",
"awards",
"certificates",
"publications",
"projects",
"skills",
"languages",
"interests",
"references"
],
"title": "@jskherman's CV Typst Schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | 801a82b70607636de63b5607db99f63793a49fdb | 2024-01-22T12:30:13 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"default": {},
"properties": {
"affiliations": {
"default": [],
"items": {
"properties": {
"endDate": {
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"location",
"position",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"awards": {
"default": [],
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"null",
"array"
]
},
"issuer": {
"type": "string"
},
"location": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"date",
"issuer"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"certificates": {
"default": [],
"items": {
"default": {},
"properties": {
"date": {
"default": "",
"format": "date",
"type": "string"
},
"issuer": {
"default": "",
"type": "string"
},
"name": {
"default": "",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"education": {
"default": [],
"items": {
"properties": {
"area": {
"type": "string"
},
"courses": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"endDate": {
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"honors": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"institution": {
"type": "string"
},
"location": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"studyType": {
"type": "string"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"location",
"area",
"studyType",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"interests": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"languages": {
"default": [],
"items": {
"properties": {
"fluency": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"type": "object"
},
"type": "array"
},
"personal": {
"default": {},
"properties": {
"email": {
"default": "",
"format": "email",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"properties": {
"city": {
"default": "",
"type": "string"
},
"country": {
"default": "",
"type": "string"
},
"postalCode": {
"default": 0,
"type": "integer"
},
"region": {
"default": "",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"type": "string"
},
"phone": {
"default": "",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"items": {
"properties": {
"network": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"type": "object"
},
"type": "array"
},
"url": {
"default": "",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"type": "object"
},
"projects": {
"default": [],
"items": {
"default": {},
"properties": {
"affiliation": {
"default": "",
"type": "string"
},
"endDate": {
"default": "",
"type": "string"
},
"highlights": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"default": "",
"type": "string"
},
"startDate": {
"default": "",
"format": "date",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"publications": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"type": "string"
},
"publisher": {
"default": "",
"type": "string"
},
"releaseDate": {
"default": "",
"format": "date",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"type": "string"
},
"reference": {
"default": "",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"skills": {
"default": [],
"items": {
"properties": {
"category": {
"type": "string"
},
"skills": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"category",
"skills"
],
"type": "object"
},
"type": "array"
},
"work": {
"default": [],
"items": {
"properties": {
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"positions": {
"items": {
"properties": {
"endDate": {
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
}
},
"required": [
"position",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"location",
"positions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.