Forge
Plugins

Conformance

Plugin for workspace conformance rules

@bjb-forge/nx-conformance-project

Installation

npx @bjb-forge/cli add @bjb-forge/nx-conformance-project

Plugin Options

{
  "plugin": "@bjb-forge/nx-conformance-project/nx-plugin",
  "options": {}
}
OptionTypeDescription
assetsarrayAssets to copy during conformance sync

Inferred Targets

build

Compiles the conformance package using TypeScript.

Condition: Conformance projects with a package.json

lint

Runs ESLint to check code quality.

Condition: Conformance projects with a package.json

test

Runs unit tests using Jest.

Condition: Conformance projects with a package.json

Generators

conformance-project

Create a conformance project.

nx g @bjb-forge/nx-conformance-project:conformance-project [options]
OptionTypeRequiredDefaultDescription
directorystringYes-A directory where the project is placed
scopestringNoforgeImport path scope

conformance-rule

Create a conformance rule.

nx g @bjb-forge/nx-conformance-project:conformance-rule [options]
OptionTypeRequiredDefaultDescription
directorystringYes-A directory of the plugin project
e2eDirectorystringYes-A directory of the e2e plugin project

On this page