Skip to content

Commit

Permalink
docs(core): nx dev release script (#5979)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcabanes committed Jun 11, 2021
1 parent f975178 commit 8f397c5
Show file tree
Hide file tree
Showing 696 changed files with 13,237 additions and 8,801 deletions.
2 changes: 1 addition & 1 deletion nx-dev/data-access-documents/src/lib/documents.api.spec.ts
Expand Up @@ -24,7 +24,7 @@ describe('DocumentsApi', () => {
it('should retrieve documents that exist', () => {
const result = api.getDocument('latest', 'react', [
'getting-started',
'getting-started',
'intro',
]);

expect(result.filePath).toBeTruthy();
Expand Down
@@ -0,0 +1,33 @@
# delegate-build

Delegates the build to a different target while supporting incremental builds.

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

## Properties

### buildTarget

Type: `string`

Build target used for building the app after its dependencies have been built.

### outputPath

Type: `string`

The full path for the output directory, relative to the workspace root.

### tsConfig

Type: `string`

The full path for the TypeScript configuration file, relative to the workspace root.

### watch

Default: `false`

Type: `boolean`

Run build when files change.
@@ -1,6 +1,6 @@
# ng-packagr-lite

Build an Angular library for incremental building
Build an Angular library for incremental building.

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

Expand All @@ -14,7 +14,7 @@ Type: `string`

Possible values: `dependencies`, `peerDependencies`

When updateBuildableProjectDepsInPackageJson is true, this adds dependencies to either `peerDependencies` or `dependencies`
When `updateBuildableProjectDepsInPackageJson` is `true`, this adds dependencies to either `peerDependencies` or `dependencies`.

### project

Expand All @@ -34,7 +34,7 @@ Default: `true`

Type: `boolean`

Update buildable project dependencies in package.json
Update buildable project dependencies in package.json.

### watch

Expand Down
@@ -1,6 +1,6 @@
# package

Build and package an Angular library for publishing
Build and package an Angular library for publishing.

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

Expand All @@ -14,7 +14,7 @@ Type: `string`

Possible values: `dependencies`, `peerDependencies`

When updateBuildableProjectDepsInPackageJson is true, this adds dependencies to either `peerDependencies` or `dependencies`
When `updateBuildableProjectDepsInPackageJson` is `true`, this adds dependencies to either `peerDependencies` or `dependencies`.

### project

Expand All @@ -34,7 +34,7 @@ Default: `true`

Type: `boolean`

Update buildable project dependencies in package.json
Update buildable project dependencies in package.json.

### watch

Expand Down
@@ -1,6 +1,6 @@
# webpack-browser

Angular browser builder that supports incremental builds
Angular browser builder that supports incremental builds.

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

Expand All @@ -14,7 +14,7 @@ A list of CommonJS packages that are allowed to be used without a build time war

### aot

Default: `false`
Default: `true`

Type: `boolean`

Expand All @@ -40,7 +40,7 @@ Budget thresholds to ensure parts of your application stay within boundaries whi

### buildOptimizer

Default: `false`
Default: `true`

Type: `boolean`

Expand All @@ -52,7 +52,7 @@ Default: `true`

Type: `boolean`

Use a separate bundle containing code used across multiple bundles.
Generate a seperate bundle containing code used across multiple bundles.

### crossOrigin

Expand All @@ -78,25 +78,19 @@ Type: `string`

URL where files will be deployed.

### experimentalRollupPass
### ~~extractCss~~

Default: `false`
Default: `true`

Type: `boolean`

Concatenate modules with Rollup before bundling them with Webpack.
**Deprecated:** Deprecated since version 11.0. No longer required to disable CSS extraction for HMR.

### extractCss

Default: `false`

Type: `boolean`

Extract css from global styles into css files instead of js ones.
Extract CSS from global styles into '.css' files instead of '.js'.

### extractLicenses

Default: `false`
Default: `true`

Type: `boolean`

Expand All @@ -108,32 +102,6 @@ Type: `array`

Replace compilation source files with other compilation source files in the build.

### forkTypeChecker

Default: `true`

Type: `boolean`

Run the TypeScript type checker in a forked process.

### i18nFile

Type: `string`

Localization file to use for i18n.

### i18nFormat

Type: `string`

Format of the localization file specified with --i18n-file.

### i18nLocale

Type: `string`

Locale to use for i18n.

### i18nMissingTranslation

Default: `warning`
Expand All @@ -150,16 +118,22 @@ Type: `string`

Configures the generation of the application's HTML index.

### lazyModules
### inlineStyleLanguage

Type: `array`
Default: `css`

Type: `string`

List of additional NgModule files that will be lazy loaded. Lazy router modules will be discovered automatically.
Possible values: `css`, `less`, `sass`, `scss`

The stylesheet language to use for the application's inline component styles.

### localize

Type: `boolean | boolean[] `

Translate the bundles in one or more locales.

### main

Type: `string`
Expand All @@ -168,7 +142,7 @@ The full path for the main entry point to the app, relative to the current works

### namedChunks

Default: `true`
Default: `false`

Type: `boolean`

Expand All @@ -182,11 +156,11 @@ Path to ngsw-config.json.

### optimization

Default: `false`
Default: `true`

Type: `boolean`

Enables optimization of the build output.
Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, inlining of critical CSS and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-configuration.

### outputHashing

Expand Down Expand Up @@ -226,6 +200,8 @@ Do not use the real path when resolving modules. If unset then will default to `

### progress

Default: `true`

Type: `boolean`

Log progress to the console while building.
Expand All @@ -250,21 +226,23 @@ Type: `boolean`

Generates a service worker config for production builds.

### showCircularDependencies
### ~~showCircularDependencies~~

Default: `true`
Default: `false`

Type: `boolean`

**Deprecated:** The recommended method to detect circular dependencies in project code is to use either a lint rule or other external tooling.

Show circular dependency warnings on builds.

### sourceMap

Default: `true`
Default: `false`

Type: `boolean`

Output sourcemaps.
Output source maps for scripts and styles. For more information, see https://angular.io/guide/workspace-config#source-map-configuration.

### statsJson

Expand Down Expand Up @@ -296,11 +274,11 @@ The full path for the TypeScript configuration file, relative to the current wor

### vendorChunk

Default: `true`
Default: `false`

Type: `boolean`

Use a separate bundle containing only vendor libraries.
Generate a seperate bundle containing only vendor libraries. This option should only used for development.

### verbose

Expand Down
Expand Up @@ -50,14 +50,6 @@ Possible values: `protractor`, `cypress`, `none`

Test runner to use for end to end (e2e) tests

### enableIvy

Default: `true`

Type: `boolean`

Create a new app that uses the Ivy rendering engine.

### inlineStyle

Alias(es): s
Expand All @@ -84,7 +76,7 @@ Default: `eslint`

Type: `string`

Possible values: `tslint`, `eslint`
Possible values: `eslint`, `none`

The tool to use for running lint checks.

Expand Down Expand Up @@ -138,7 +130,7 @@ Skip creating spec files.

### strict

Default: `false`
Default: `true`

Type: `boolean`

Expand Down
@@ -0,0 +1,55 @@
# convert-tslint-to-eslint

Convert a project from TSLint to ESLint

## Usage

```bash
nx generate convert-tslint-to-eslint ...
```

By default, Nx will search for `convert-tslint-to-eslint` in the default collection provisioned in `angular.json`.

You can specify the collection explicitly as follows:

```bash
nx g @nrwl/angular:convert-tslint-to-eslint ...
```

Show what will be generated without writing to disk:

```bash
nx g convert-tslint-to-eslint ... --dry-run
```

### Examples

Convert the Angular project `myapp` from TSLint to ESLint:

```bash
nx g convert-tslint-to-eslint myapp
```

## Options

### ignoreExistingTslintConfig

Default: `false`

Type: `boolean`

If true we will not use existing TSLint config as a reference, we will just reset the project with the latest recommended ESLint config

### project

Type: `string`

The name of the Angular project to convert. Please note, if the project is an Angular app with an associated Cypress e2e project, we will also attempt to convert that.

### removeTSLintIfNoMoreTSLintTargets

Default: `true`

Type: `boolean`

If this conversion leaves no more TSLint usage in the workspace, it will remove TSLint and related dependencies and configuration
@@ -1,6 +1,6 @@
# karma-project

Add karma testing to a project
Add karma testing to a project.

## Usage

Expand Down
@@ -1,6 +1,6 @@
# karma

Add karma configuration to a workspace
Add karma configuration to a workspace.

## Usage

Expand Down

0 comments on commit 8f397c5

Please sign in to comment.