Skip to content

Commit

Permalink
chore(gatsby): move gatsby plugin to main repo
Browse files Browse the repository at this point in the history
  • Loading branch information
jaysoo authored and vsavkin committed Jan 26, 2021
1 parent ffe769f commit 51973b8
Show file tree
Hide file tree
Showing 98 changed files with 4,361 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ var_2:
'e2e-cli,e2e-nx-plugin,dep-graph-client-e2e',
'e2e-cypress,e2e-jest',
'e2e-react',
'e2e-next',
'e2e-next,e2e-gatsby',
'e2e-node',
'e2e-web,e2e-linter,e2e-storybook',
]
Expand Down
1 change: 1 addition & 0 deletions .cz-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ module.exports = {
{ name: 'core', description: 'anything Nx core specific' },
{ name: 'nxdev', description: 'anything related to docs infrastructure' },
{ name: 'nextjs', description: 'anything Next specific' },
{ name: 'gatsby', description: 'anything Gatsby specific' },
{ name: 'nest', description: 'anything Nest specific' },
{ name: 'node', description: 'anything Node specific' },
{ name: 'express', description: 'anything Express specific' },
Expand Down
47 changes: 47 additions & 0 deletions docs/angular/api-gatsby/executors/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# build

Build a Gatsby app

Properties can be configured in angular.json when defining the executor, or when invoking it.

## Properties

### color

Default: `true`

Type: `boolean`

Enable colored terminal output.

### graphqlTracing

Type: `boolean`

Trace every graphql resolver, may have performance implications.

### openTracingConfigFile

Type: `string`

Tracer configuration file (OpenTracing compatible).

### prefixPaths

Type: `boolean`

Build site with link paths prefixed (set pathPrefix in your config).

### profile

Type: `boolean`

Build site with react profiling.

### uglify

Default: `true`

Type: `boolean`

Build site without uglifying JS bundles (true by default).
43 changes: 43 additions & 0 deletions docs/angular/api-gatsby/executors/server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# server

Starts server for app

Properties can be configured in angular.json when defining the executor, or when invoking it.

## Properties

### buildTarget

Type: `string`

Target which builds the application

### host

Default: `localhost`

Type: `string`

Host to listen on.

### https

Default: `false`

Type: `boolean`

Serve using HTTPS.

### open

Type: `boolean`

Open the site in your (default) browser for you.

### port

Default: `4200`

Type: `number`

Port to listen on.
89 changes: 89 additions & 0 deletions docs/angular/api-gatsby/generators/application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# application

Create an application

## Usage

```bash
nx generate application ...
```

```bash
nx g app ... # same
```

By default, Nx will search for `application` in the default collection provisioned in `angular.json`.

You can specify the collection explicitly as follows:

```bash
nx g @nrwl/gatsby:application ...
```

Show what will be generated without writing to disk:

```bash
nx g application ... --dry-run
```

## Options

### directory

Alias(es): d

Type: `string`

A directory where the project is placed

### e2eTestRunner

Default: `cypress`

Type: `string`

Possible values: `cypress`, `none`

Adds the specified e2e test runner

### js

Default: `false`

Type: `boolean`

Generate JavaScript files rather than TypeScript files

### name

Type: `string`

### style

Alias(es): s

Default: `css`

Type: `string`

Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `none`

The file extension to be used for style files.

### tags

Alias(es): t

Type: `string`

Add tags to the project (used for linting)

### unitTestRunner

Default: `jest`

Type: `string`

Possible values: `jest`, `none`

Adds the specified unit test runner
107 changes: 107 additions & 0 deletions docs/angular/api-gatsby/generators/component.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# component

Create a component

## Usage

```bash
nx generate component ...
```

By default, Nx will search for `component` in the default collection provisioned in `angular.json`.

You can specify the collection explicitly as follows:

```bash
nx g @nrwl/gatsby:component ...
```

Show what will be generated without writing to disk:

```bash
nx g component ... --dry-run
```

### Examples

Generate a component in the mylib library:

```bash
nx g component my-component --project=mylib
```

Generate a class component in the mylib library:

```bash
nx g component my-component --project=mylib --classComponent
```

## Options

### directory

Alias(es): d

Type: `string`

Create the component under this directory (can be nested).

### export

Alias(es): e

Default: `false`

Type: `boolean`

When true, the component is exported from the project index.ts (if it exists).

### flat

Default: `false`

Type: `boolean`

Create component at the source root rather than its own directory.

### js

Default: `false`

Type: `boolean`

Generate JavaScript files rather than TypeScript files.

### name

Type: `string`

The name of the component.

### project

Alias(es): p

Type: `string`

The name of the project.

### skipTests

Default: `false`

Type: `boolean`

When true, does not create "spec.ts" test files for the new component.

### style

Alias(es): s

Default: `css`

Type: `string`

Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `none`

The file extension to be used for style files.
Loading

0 comments on commit 51973b8

Please sign in to comment.