javascript
Submodule
Constructs
Bundler
Adds support for bundling JavaScript applications and dependencies into a single file.
In the future, this will also supports bundling websites.
Initializers
import { javascript } from 'projen'
new javascript.Bundler(project: Project, options?: BundlerOptions)
Name | Type | Description |
---|---|---|
| projen.Project | No description. |
|
| No description. |
project
Required
- Type: projen.Project
options
Optional
- Type: BundlerOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| Adds a task to the project which bundles a specific entrypoint and all of its dependencies into a single javascript output file. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addBundle
public addBundle(entrypoint: string, options: AddBundleOptions): Bundle
Adds a task to the project which bundles a specific entrypoint and all of its dependencies into a single javascript output file.
entrypoint
Required
- Type: string
The relative path of the artifact within the project.
options
Required
- Type: AddBundleOptions
Bundling options.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
| Returns the Bundler instance associated with a project or undefined if there is no Bundler. |
isConstruct
import { javascript } from 'projen'
javascript.Bundler.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.Bundler.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.Bundler.of(project: Project)
Returns the Bundler
instance associated with a project or undefined
if there is no Bundler.
project
Required
- Type: projen.Project
The project.
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| string | Root bundle directory. |
| projen.Task | Gets or creates the singleton "bundle" task of the project. |
| string | The semantic version requirement for esbuild (if defined). |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
bundledir
Required
public readonly bundledir: string;
- Type: string
Root bundle directory.
bundleTask
Required
public readonly bundleTask: Task;
- Type: projen.Task
Gets or creates the singleton "bundle" task of the project.
If the project doesn't have a "bundle" task, it will be created and spawned during the pre-compile phase.
esbuildVersion
Optional
public readonly esbuildVersion: string;
- Type: string
The semantic version requirement for esbuild
(if defined).
Eslint
Represents eslint configuration.
Initializers
import { javascript } from 'projen'
new javascript.Eslint(project: NodeProject, options: EslintOptions)
Name | Type | Description |
---|---|---|
|
| No description. |
|
| No description. |
project
Required
- Type: NodeProject
options
Required
- Type: EslintOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| Adds an extends item to the eslint configuration. |
| Do not lint these files. |
| Add a file, glob pattern or directory with source files to lint (e.g. [ "src" ]). |
| Add an eslint override. |
| Adds an eslint plugin. |
| Add an eslint rule. |
| Add a glob file pattern which allows importing dev dependencies. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addExtends
public addExtends(extendList: ...string[]): void
Adds an extends
item to the eslint configuration.
extendList
Required
- Type: ...string[]
The list of "extends" to add.
addIgnorePattern
public addIgnorePattern(pattern: string): void
Do not lint these files.
pattern
Required
- Type: string
addLintPattern
public addLintPattern(pattern: string): void
Add a file, glob pattern or directory with source files to lint (e.g. [ "src" ]).
pattern
Required
- Type: string
addOverride
public addOverride(override: EslintOverride): void
Add an eslint override.
override
Required
- Type: EslintOverride
addPlugins
public addPlugins(plugins: ...string[]): void
Adds an eslint plugin.
plugins
Required
- Type: ...string[]
The names of plugins to add.
addRules
public addRules(rules: {[ key: string ]: any}): void
Add an eslint rule.
rules
Required
- Type: {[ key: string ]: any}
allowDevDeps
public allowDevDeps(pattern: string): void
Add a glob file pattern which allows importing dev dependencies.
pattern
Required
- Type: string
glob pattern.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
| Returns the singleton Eslint component of a project or undefined if there is none. |
isConstruct
import { javascript } from 'projen'
javascript.Eslint.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.Eslint.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.Eslint.of(project: Project)
Returns the singleton Eslint component of a project or undefined if there is none.
project
Required
- Type: projen.Project
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| any | Direct access to the eslint configuration (escape hatch). |
| projen.Task | eslint task. |
| string[] | File patterns that should not be linted. |
| string[] | Returns an immutable copy of the lintPatterns being used by this eslint configuration. |
|
| eslint overrides. |
| {[ key: string ]: any[]} | eslint rules. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
config
Required
public readonly config: any;
- Type: any
Direct access to the eslint configuration (escape hatch).
eslintTask
Required
public readonly eslintTask: Task;
- Type: projen.Task
eslint task.
ignorePatterns
Required
public readonly ignorePatterns: string[];
- Type: string[]
File patterns that should not be linted.
lintPatterns
Required
public readonly lintPatterns: string[];
- Type: string[]
Returns an immutable copy of the lintPatterns being used by this eslint configuration.
overrides
Required
public readonly overrides: EslintOverride[];
- Type: EslintOverride[]
eslint overrides.
rules
Required
public readonly rules: {[ key: string ]: any[]};
- Type: {[ key: string ]: any[]}
eslint rules.
Jest
Installs the following npm scripts:.
test
, intended for testing locally and in CI. Will update snapshots unless updateSnapshot: UpdateSnapshot: NEVER
is set.
test:watch
, intended for automatically rerunning tests when files change.test:update
, intended for testing locally and updating snapshots to match the latest unit under test. Only available whenupdateSnapshot: UpdateSnapshot: NEVER
.
Initializers
import { javascript } from 'projen'
new javascript.Jest(project: NodeProject, options?: JestOptions)
Name | Type | Description |
---|---|---|
|
| No description. |
|
| No description. |
project
Required
- Type: NodeProject
options
Optional
- Type: JestOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| No description. |
| Adds one or more moduleNameMapper entries to Jest's configuration. |
| Adds one or more modulePaths to Jest's configuration. |
| No description. |
| Adds one or more roots to Jest's configuration. |
| Adds a a setup file to Jest's setupFiles configuration. |
| Adds a a setup file to Jest's setupFilesAfterEnv configuration. |
| No description. |
| Adds a test match pattern. |
| Adds a watch ignore pattern. |
| Build standard test match patterns for a directory. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addIgnorePattern
public addIgnorePattern(pattern: string): void
pattern
Required
- Type: string
addModuleNameMappers
public addModuleNameMappers(moduleNameMapperAdditions: {[ key: string ]: string | string[]}): void
Adds one or more moduleNameMapper entries to Jest's configuration.
Will overwrite if the same key is used as a pre-existing one.
moduleNameMapperAdditions
Required
- Type: {[ key: string ]: string | string[]}
A map from regular expressions to module names or to arrays of module names that allow to stub out resources, like images or styles with a single module.
addModulePaths
public addModulePaths(modulePaths: ...string[]): void
Adds one or more modulePaths to Jest's configuration.
modulePaths
Required
- Type: ...string[]
An array of absolute paths to additional locations to search when resolving modules *.
addReporter
public addReporter(reporter: JestReporter): void
reporter
Required
- Type: JestReporter
addRoots
public addRoots(roots: ...string[]): void
Adds one or more roots to Jest's configuration.
roots
Required
- Type: ...string[]
A list of paths to directories that Jest should use to search for files in.
addSetupFile
public addSetupFile(file: string): void
Adds a a setup file to Jest's setupFiles configuration.
file
Required
- Type: string
File path to setup file.
addSetupFileAfterEnv
public addSetupFileAfterEnv(file: string): void
Adds a a setup file to Jest's setupFilesAfterEnv configuration.
file
Required
- Type: string
File path to setup file.
addSnapshotResolver
public addSnapshotResolver(file: string): void
file
Required
- Type: string
addTestMatch
public addTestMatch(pattern: string): void
Adds a test match pattern.
pattern
Required
- Type: string
glob pattern to match for tests.
addWatchIgnorePattern
public addWatchIgnorePattern(pattern: string): void
Adds a watch ignore pattern.
pattern
Required
- Type: string
The pattern (regular expression).
discoverTestMatchPatternsForDirs
public discoverTestMatchPatternsForDirs(dirs: string[], options?: JestDiscoverTestMatchPatternsForDirsOptions): void
Build standard test match patterns for a directory.
dirs
Required
- Type: string[]
The directories to add test matches for.
Matches any folder if not specified or an empty array.
options
Optional
Options for building test match patterns.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
| Returns the singleton Jest component of a project or undefined if there is none. |
isConstruct
import { javascript } from 'projen'
javascript.Jest.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.Jest.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.Jest.of(project: Project)
Returns the singleton Jest component of a project or undefined if there is none.
project
Required
- Type: projen.Project
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| any | Escape hatch. |
| string | Jest version, including @ symbol, like @^29 . |
| projen.JsonFile | Jest config file. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
config
Required
public readonly config: any;
- Type: any
Escape hatch.
jestVersion
Required
public readonly jestVersion: string;
- Type: string
Jest version, including @
symbol, like @^29
.
file
Optional
public readonly file: JsonFile;
- Type: projen.JsonFile
Jest config file.
undefined
if settings are written to package.json
LicenseChecker
Enforces allowed licenses used by dependencies.
Initializers
import { javascript } from 'projen'
new javascript.LicenseChecker(scope: Construct, options: LicenseCheckerOptions)
Name | Type | Description |
---|---|---|
| constructs.Construct | No description. |
|
| No description. |
scope
Required
- Type: constructs.Construct
options
Required
- Type: LicenseCheckerOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
isConstruct
import { javascript } from 'projen'
javascript.LicenseChecker.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.LicenseChecker.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| projen.Task | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
task
Required
public readonly task: Task;
- Type: projen.Task
NodePackage
Represents the npm package.json
file.
Initializers
import { javascript } from 'projen'
new javascript.NodePackage(project: Project, options?: NodePackageOptions)
Name | Type | Description |
---|---|---|
| projen.Project | No description. |
|
| No description. |
project
Required
- Type: projen.Project
options
Optional
- Type: NodePackageOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| No description. |
| Defines bundled dependencies. |
| Defines normal dependencies. |
| Defines development/test dependencies. |
| Adds an engines requirement to your package. |
| Directly set fields in package.json . |
| Adds keywords to package.json (deduplicated). |
| Defines resolutions for dependencies to change the normally resolved version of a dependency to something else. |
| Defines peer dependencies. |
| Sets the package version. |
| Indicates if a script by the given name is defined. |
| Removes an npm script (always successful). |
| Add a npm package.json script. |
| Attempt to resolve the currently installed version for a given dependency. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addBin
public addBin(bins: {[ key: string ]: string}): void
bins
Required
- Type: {[ key: string ]: string}
addBundledDeps
public addBundledDeps(deps: ...string[]): void
Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
bundledDependencies
section of your package.json
.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addDeps
public addDeps(deps: ...string[]): void
Defines normal dependencies.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addDevDeps
public addDevDeps(deps: ...string[]): void
Defines development/test dependencies.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addEngine
public addEngine(engine: string, version: string): void
Adds an engines
requirement to your package.
engine
Required
- Type: string
The engine (e.g. node
).
version
Required
- Type: string
The semantic version requirement (e.g. ^10
).
addField
public addField(name: string, value: any): void
Directly set fields in package.json
.
name
Required
- Type: string
field name.
value
Required
- Type: any
field value.
addKeywords
public addKeywords(keywords: ...string[]): void
Adds keywords to package.json (deduplicated).
keywords
Required
- Type: ...string[]
The keywords to add.
addPackageResolutions
public addPackageResolutions(resolutions: ...string[]): void
Defines resolutions for dependencies to change the normally resolved version of a dependency to something else.
resolutions
Required
- Type: ...string[]
Names resolutions to be added.
Specify a version or
range with this syntax:
module@^7
addPeerDeps
public addPeerDeps(deps: ...string[]): void
Defines peer dependencies.
When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addVersion
public addVersion(version: string): void
Sets the package version.
version
Required
- Type: string
Package version.
hasScript
hasScript
public hasScript(name: string): boolean
Indicates if a script by the given name is defined.
name
Required
- Type: string
The name of the script.
removeScript
public removeScript(name: string): void
Removes an npm script (always successful).
name
Required
- Type: string
The name of the script.
setScript
public setScript(name: string, command: string): void
Add a npm package.json script.
name
Required
- Type: string
The script name.
command
Required
- Type: string
The command to execute.
tryResolveDependencyVersion
public tryResolveDependencyVersion(dependencyName: string): string
Attempt to resolve the currently installed version for a given dependency.
dependencyName
Required
- Type: string
Dependency to resolve for.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
| Returns the NodePackage instance associated with a project or undefined if there is no NodePackage. |
isConstruct
import { javascript } from 'projen'
javascript.NodePackage.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.NodePackage.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.NodePackage.of(project: Project)
Returns the NodePackage
instance associated with a project or undefined
if there is no NodePackage.
project
Required
- Type: projen.Project
The project.
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| boolean | Allow project to take library dependencies. |
| string | The module's entrypoint (e.g. lib/index.js ). |
| projen.JsonFile | The package.json file. |
| string | Renders yarn install or npm install with lockfile update (not frozen). |
| projen.Task | The task for installing project dependencies (frozen). |
| string | Returns the command to execute in order to install all dependencies (always frozen). |
| projen.Task | The task for installing project dependencies (non-frozen). |
| string | The name of the lock file. |
| any | No description. |
|
| npm package access level. |
| boolean | Should provenance statements be generated when package is published. |
| string | The npm registry host (e.g. registry.npmjs.org ). |
| string | npm registry (e.g. https://registry.npmjs.org ). Use npmRegistryHost to get just the host name. |
|
| The package manager to use. |
| string | The name of the npm package. |
| string | The command which executes "projen". |
| string | The version of Bun to use if using Bun as a package manager. |
|
| Options for npm packages using AWS CodeArtifact. |
| string | The SPDX license of this module. |
| string | Maximum node version supported by this package. |
| string | The minimum node version required by this package to function. |
| string | GitHub secret which contains the NPM token to use when publishing packages. |
| string | The version of PNPM to use if using PNPM as a package manager. |
|
| Options for privately hosted scoped packages. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
allowLibraryDependencies
Required
public readonly allowLibraryDependencies: boolean;
- Type: boolean
Allow project to take library dependencies.
entrypoint
Required
public readonly entrypoint: string;
- Type: string
The module's entrypoint (e.g. lib/index.js
).
file
Required
public readonly file: JsonFile;
- Type: projen.JsonFile
The package.json file.
installAndUpdateLockfileCommand
Required
public readonly installAndUpdateLockfileCommand: string;
- Type: string
Renders yarn install
or npm install
with lockfile update (not frozen).
installCiTask
Required
public readonly installCiTask: Task;
- Type: projen.Task
The task for installing project dependencies (frozen).
installCommand
Required
public readonly installCommand: string;
- Type: string
Returns the command to execute in order to install all dependencies (always frozen).
installTask
Required
public readonly installTask: Task;
- Type: projen.Task
The task for installing project dependencies (non-frozen).
lockFile
Required
public readonly lockFile: string;
- Type: string
The name of the lock file.
manifest
Required
manifest
- Deprecated: use
addField(x, y)
public readonly manifest: any;
- Type: any
npmAccess
Required
public readonly npmAccess: NpmAccess;
- Type: NpmAccess
npm package access level.
npmProvenance
Required
public readonly npmProvenance: boolean;
- Type: boolean
Should provenance statements be generated when package is published.
npmRegistry
Required
public readonly npmRegistry: string;
- Type: string
The npm registry host (e.g. registry.npmjs.org
).
npmRegistryUrl
Required
public readonly npmRegistryUrl: string;
- Type: string
npm registry (e.g. https://registry.npmjs.org
). Use npmRegistryHost
to get just the host name.
packageManager
Required
public readonly packageManager: NodePackageManager;
- Type: NodePackageManager
The package manager to use.
packageName
Required
public readonly packageName: string;
- Type: string
The name of the npm package.
projenCommand
Required
projenCommand
- Deprecated: use
project.projenCommand
instead.
public readonly projenCommand: string;
- Type: string
The command which executes "projen".
bunVersion
Optional
public readonly bunVersion: string;
- Type: string
The version of Bun to use if using Bun as a package manager.
codeArtifactOptions
Optional
public readonly codeArtifactOptions: CodeArtifactOptions;
- Type: CodeArtifactOptions
- Default: undefined
Options for npm packages using AWS CodeArtifact.
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
license
Optional
public readonly license: string;
- Type: string
The SPDX license of this module.
undefined
if this package is not licensed.
maxNodeVersion
Optional
public readonly maxNodeVersion: string;
- Type: string
Maximum node version supported by this package.
The value indicates the package is incompatible with newer versions.
minNodeVersion
Optional
public readonly minNodeVersion: string;
- Type: string
The minimum node version required by this package to function.
This value indicates the package is incompatible with older versions.
npmTokenSecret
Optional
public readonly npmTokenSecret: string;
- Type: string
GitHub secret which contains the NPM token to use when publishing packages.
pnpmVersion
Optional
public readonly pnpmVersion: string;
- Type: string
The version of PNPM to use if using PNPM as a package manager.
scopedPackagesOptions
Optional
public readonly scopedPackagesOptions: ScopedPackagesOptions[];
- Type: ScopedPackagesOptions[]
- Default: undefined
Options for privately hosted scoped packages.
NodeProject
Node.js project.
Initializers
import { javascript } from 'projen'
new javascript.NodeProject(options: NodeProjectOptions)
Name | Type | Description |
---|---|---|
|
| No description. |
options
Required
- Type: NodeProjectOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Exclude the matching files from pre-synth cleanup. |
| Adds a .gitignore pattern. |
| Adds patterns to be ignored by npm. |
| Adds a new task to this project. |
| Prints a "tip" message during synthesis. |
| Marks the provided file(s) as being generated. |
| Called after all components are synthesized. |
| Called before all components are synthesized. |
| Removes a task from a project. |
| Returns the shell command to execute in order to run a task. |
| Synthesize all project files into outdir . |
| Finds a file at the specified relative path within this project and all its subprojects. |
| Finds a json file by name. |
| Finds an object file (like JsonFile, YamlFile, etc.) by name. |
| Finds a file at the specified relative path within this project and removes it. |
| No description. |
| Defines bundled dependencies. |
| DEPRECATED. |
| Defines normal dependencies. |
| Defines development/test dependencies. |
| Directly set fields in package.json . |
| Adds keywords to package.json (deduplicated). |
| Defines peer dependencies. |
| Replaces the contents of multiple npm package.json scripts. |
| DEPRECATED. |
| Indicates if a script by the name name is defined. |
| Removes the npm script (always successful). |
| Returns the set of workflow steps which should be executed to bootstrap a workflow. |
| Replaces the contents of an npm package.json script. |
toString
public toString(): string
Returns a string representation of this construct.
addExcludeFromCleanup
public addExcludeFromCleanup(globs: ...string[]): void
Exclude the matching files from pre-synth cleanup.
Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.
globs
Required
- Type: ...string[]
The glob patterns to match.
addGitIgnore
public addGitIgnore(pattern: string): void
Adds a .gitignore pattern.
pattern
Required
- Type: string
The glob pattern to ignore.
addPackageIgnore
public addPackageIgnore(pattern: string): void
Adds patterns to be ignored by npm.
pattern
Required
- Type: string
The pattern to ignore.
addTask
public addTask(name: string, props?: TaskOptions): Task
Adds a new task to this project.
This will fail if the project already has a task with this name.
name
Required
- Type: string
The task name to add.
props
Optional
- Type: projen.TaskOptions
Task properties.
addTip
addTip
public addTip(message: string): void
Prints a "tip" message during synthesis.
message
Required
- Type: string
The message.
annotateGenerated
public annotateGenerated(glob: string): void
Marks the provided file(s) as being generated.
This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.
https://github.com/github/linguist/blob/master/docs/overrides.md
glob
Required
- Type: string
the glob pattern to match (could be a file path).
postSynthesize
public postSynthesize(): void
Called after all components are synthesized.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before all components are synthesized.
removeTask
public removeTask(name: string): Task
Removes a task from a project.
name
Required
- Type: string
The name of the task to remove.
runTaskCommand
public runTaskCommand(task: Task): string
Returns the shell command to execute in order to run a task.
This will
typically be npx projen TASK
.
task
Required
- Type: projen.Task
The task for which the command is required.
synth
public synth(): void
Synthesize all project files into outdir
.
- Call "this.preSynthesize()"
- Delete all generated files
- Synthesize all subprojects
- Synthesize all components of this project
- Call "postSynthesize()" for all components of this project
- Call "this.postSynthesize()"
tryFindFile
public tryFindFile(filePath: string): FileBase
Finds a file at the specified relative path within this project and all its subprojects.
filePath
Required
- Type: string
The file path.
If this path is relative, it will be resolved from the root of this project.
tryFindJsonFile
tryFindJsonFile
public tryFindJsonFile(filePath: string): JsonFile
Finds a json file by name.
filePath
Required
- Type: string
The file path.
tryFindObjectFile
public tryFindObjectFile(filePath: string): ObjectFile
Finds an object file (like JsonFile, YamlFile, etc.) by name.
filePath
Required
- Type: string
The file path.
tryRemoveFile
public tryRemoveFile(filePath: string): FileBase
Finds a file at the specified relative path within this project and removes it.
filePath
Required
- Type: string
The file path.
If this path is relative, it will be resolved from the root of this project.
addBins
public addBins(bins: {[ key: string ]: string}): void
bins
Required
- Type: {[ key: string ]: string}
addBundledDeps
public addBundledDeps(deps: ...string[]): void
Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
bundledDependencies
section of your package.json
.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addCompileCommand
addCompileCommand
public addCompileCommand(commands: ...string[]): void
DEPRECATED.
commands
Required
- Type: ...string[]
addDeps
public addDeps(deps: ...string[]): void
Defines normal dependencies.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addDevDeps
public addDevDeps(deps: ...string[]): void
Defines development/test dependencies.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addFields
public addFields(fields: {[ key: string ]: any}): void
Directly set fields in package.json
.
fields
Required
- Type: {[ key: string ]: any}
The fields to set.
addKeywords
public addKeywords(keywords: ...string[]): void
Adds keywords to package.json (deduplicated).
keywords
Required
- Type: ...string[]
The keywords to add.
addPeerDeps
public addPeerDeps(deps: ...string[]): void
Defines peer dependencies.
When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.
deps
Required
- Type: ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next npx projen
run and the version will be recorded
in your package.json
file. You can upgrade manually or using yarn add/upgrade
. If you wish to specify a version range use this syntax:
module@^7
.
addScripts
public addScripts(scripts: {[ key: string ]: string}): void
Replaces the contents of multiple npm package.json scripts.
scripts
Required
- Type: {[ key: string ]: string}
The scripts to set.
addTestCommand
addTestCommand
public addTestCommand(commands: ...string[]): void
DEPRECATED.
commands
Required
- Type: ...string[]
hasScript
hasScript
public hasScript(name: string): boolean
Indicates if a script by the name name is defined.
name
Required
- Type: string
The name of the script.
removeScript
public removeScript(name: string): void
Removes the npm script (always successful).
name
Required
- Type: string
The name of the script.
renderWorkflowSetup
public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
Returns the set of workflow steps which should be executed to bootstrap a workflow.
options
Optional
Options.
setScript
public setScript(name: string, command: string): void
Replaces the contents of an npm package.json script.
name
Required
- Type: string
The script name.
command
Required
- Type: string
The command to execute.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a project. |
| Find the closest ancestor project for given construct. |
isConstruct
import { javascript } from 'projen'
javascript.NodeProject.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isProject
import { javascript } from 'projen'
javascript.NodeProject.isProject(x: any)
Test whether the given construct is a project.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.NodeProject.of(construct: IConstruct)
Find the closest ancestor project for given construct.
When given a project, this it the project itself.
construct
Required
- Type: constructs.IConstruct
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Task | No description. |
| boolean | Whether to commit the managed files by default. |
| projen.Task | No description. |
| projen.Component[] | Returns all the components within this project. |
| projen.Dependencies | Project dependencies. |
| boolean | Whether or not the project is being ejected. |
| projen.FileBase[] | All files in this project. |
| projen.GitAttributesFile | The .gitattributes file for this repository. |
| projen.IgnoreFile | .gitignore. |
| projen.Logger | Logging utilities. |
| string | Project name. |
| string | Absolute output directory of this project. |
| projen.Task | No description. |
| projen.Task | No description. |
| projen.Task | No description. |
| projen.ProjectBuild | Manages the build process of the project. |
| string | The command to use in order to run the projen CLI. |
| projen.Project | The root project. |
| projen.Project[] | Returns all the subprojects within this project. |
| projen.Tasks | Project tasks. |
| projen.Task | No description. |
| projen.Task | This is the "default" task, the one that executes "projen". |
| projen.InitProject | The options used when this project is bootstrapped via projen new . |
| projen.Project | A parent project. |
| projen.ProjectType | No description. |
| projen.github.AutoApprove | Auto approve set up for this project. |
| projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). |
| projen.github.GitHub | Access all github components. |
| projen.Gitpod | Access for Gitpod. |
| projen.vscode.VsCode | Access all VSCode components. |
| boolean | No description. |
| string | The build output directory. |
| string | The location of the npm tarball after build (${artifactsDirectory}/js ). |
|
| No description. |
| string | No description. |
| any | No description. |
|
| The .npmrc file. |
|
| API for managing the node package. |
|
| The package manager to use. |
| string | The command to use to run scripts (e.g. yarn run or npm run depends on the package manager). |
| projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. |
| projen.build.BuildWorkflow | The PR build GitHub workflow. |
| string | The job ID of the build workflow. |
|
| The Jest configuration (if enabled). |
| string | Maximum node version supported by this package. |
| string | The minimum node version required by this package to function. |
| projen.IgnoreFile | The .npmignore file. |
|
| No description. |
| projen.release.Publisher | Package publisher. |
| projen.release.Release | Release management. |
|
| The upgrade workflow. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
buildTask
Required
public readonly buildTask: Task;
- Type: projen.Task
commitGenerated
Required
public readonly commitGenerated: boolean;
- Type: boolean
Whether to commit the managed files by default.
compileTask
Required
public readonly compileTask: Task;
- Type: projen.Task
components
Required
public readonly components: Component[];
- Type: projen.Component[]
Returns all the components within this project.
deps
Required
public readonly deps: Dependencies;
- Type: projen.Dependencies
Project dependencies.
ejected
Required
public readonly ejected: boolean;
- Type: boolean
Whether or not the project is being ejected.
files
Required
public readonly files: FileBase[];
- Type: projen.FileBase[]
All files in this project.
gitattributes
Required
public readonly gitattributes: GitAttributesFile;
- Type: projen.GitAttributesFile
The .gitattributes file for this repository.
gitignore
Required
public readonly gitignore: IgnoreFile;
- Type: projen.IgnoreFile
.gitignore.
logger
Required
public readonly logger: Logger;
- Type: projen.Logger
Logging utilities.
name
Required
public readonly name: string;
- Type: string
Project name.
outdir
Required
public readonly outdir: string;
- Type: string
Absolute output directory of this project.
packageTask
Required
public readonly packageTask: Task;
- Type: projen.Task
postCompileTask
Required
public readonly postCompileTask: Task;
- Type: projen.Task
preCompileTask
Required
public readonly preCompileTask: Task;
- Type: projen.Task
projectBuild
Required
public readonly projectBuild: ProjectBuild;
- Type: projen.ProjectBuild
Manages the build process of the project.
projenCommand
Required
public readonly projenCommand: string;
- Type: string
The command to use in order to run the projen CLI.
root
Required
public readonly root: Project;
- Type: projen.Project
The root project.
subprojects
Required
public readonly subprojects: Project[];
- Type: projen.Project[]
Returns all the subprojects within this project.
tasks
Required
public readonly tasks: Tasks;
- Type: projen.Tasks
Project tasks.
testTask
Required
public readonly testTask: Task;
- Type: projen.Task
defaultTask
Optional
public readonly defaultTask: Task;
- Type: projen.Task
This is the "default" task, the one that executes "projen".
Undefined if the project is being ejected.
initProject
Optional
public readonly initProject: InitProject;
- Type: projen.InitProject
The options used when this project is bootstrapped via projen new
.
It includes the original set of options passed to the CLI and also the JSII FQN of the project type.
parent
Optional
public readonly parent: Project;
- Type: projen.Project
A parent project.
If undefined, this is the root project.
projectType
Required
public readonly projectType: ProjectType;
- Type: projen.ProjectType
autoApprove
Optional
public readonly autoApprove: AutoApprove;
- Type: projen.github.AutoApprove
Auto approve set up for this project.
devContainer
Optional
public readonly devContainer: DevContainer;
- Type: projen.vscode.DevContainer
Access for .devcontainer.json (used for GitHub Codespaces).
This will be undefined
if devContainer boolean is false
github
Optional
public readonly github: GitHub;
- Type: projen.github.GitHub
Access all github components.
This will be undefined
for subprojects.
gitpod
Optional
public readonly gitpod: Gitpod;
- Type: projen.Gitpod
Access for Gitpod.
This will be undefined
if gitpod boolean is false
vscode
Optional
public readonly vscode: VsCode;
- Type: projen.vscode.VsCode
Access all VSCode components.
This will be undefined
for subprojects.
allowLibraryDependencies
Required
allowLibraryDependencies
- Deprecated: use
package.allowLibraryDependencies
public readonly allowLibraryDependencies: boolean;
- Type: boolean
artifactsDirectory
Required
public readonly artifactsDirectory: string;
- Type: string
The build output directory.
An npm tarball will be created under the js
subdirectory. For example, if this is set to dist
(the default), the npm
tarball will be placed under dist/js/boom-boom-1.2.3.tg
.
artifactsJavascriptDirectory
Required
public readonly artifactsJavascriptDirectory: string;
- Type: string
The location of the npm tarball after build (${artifactsDirectory}/js
).
bundler
Required
public readonly bundler: Bundler;
- Type: Bundler
entrypoint
Required
entrypoint
- Deprecated: use
package.entrypoint
public readonly entrypoint: string;
- Type: string
manifest
Required
manifest
- Deprecated: use
package.addField(x, y)
public readonly manifest: any;
- Type: any
npmrc
Required
public readonly npmrc: NpmConfig;
- Type: NpmConfig
The .npmrc file.
package
Required
public readonly package: NodePackage;
- Type: NodePackage
API for managing the node package.
packageManager
Required
packageManager
- Deprecated: use
package.packageManager
public readonly packageManager: NodePackageManager;
- Type: NodePackageManager
The package manager to use.
runScriptCommand
Required
public readonly runScriptCommand: string;
- Type: string
The command to use to run scripts (e.g. yarn run
or npm run
depends on the package manager).
autoMerge
Optional
public readonly autoMerge: AutoMerge;
- Type: projen.github.AutoMerge
Component that sets up mergify for merging approved pull requests.
buildWorkflow
Optional
public readonly buildWorkflow: BuildWorkflow;
- Type: projen.build.BuildWorkflow
The PR build GitHub workflow.
undefined
if buildWorkflow
is disabled.
buildWorkflowJobId
Optional
public readonly buildWorkflowJobId: string;
- Type: string
The job ID of the build workflow.
jest
Optional
public readonly jest: Jest;
- Type: Jest
The Jest configuration (if enabled).
maxNodeVersion
Optional
public readonly maxNodeVersion: string;
- Type: string
Maximum node version supported by this package.
The value indicates the package is incompatible with newer versions.
minNodeVersion
Optional
public readonly minNodeVersion: string;
- Type: string
The minimum node version required by this package to function.
This value indicates the package is incompatible with older versions.
npmignore
Optional
public readonly npmignore: IgnoreFile;
- Type: projen.IgnoreFile
The .npmignore file.
prettier
Optional
public readonly prettier: Prettier;
- Type: Prettier
publisher
Optional
publisher
- Deprecated: use
release.publisher
.
public readonly publisher: Publisher;
- Type: projen.release.Publisher
Package publisher.
This will be undefined
if the project does not have a
release workflow.
release
Optional
public readonly release: Release;
- Type: projen.release.Release
Release management.
upgradeWorkflow
Optional
public readonly upgradeWorkflow: UpgradeDependencies;
- Type: UpgradeDependencies
The upgrade workflow.
Constants
Name | Type | Description |
---|---|---|
| string | The name of the default task (the task executed when projen is run without arguments). |
DEFAULT_TASK
Required
public readonly DEFAULT_TASK: string;
- Type: string
The name of the default task (the task executed when projen
is run without arguments).
Normally this task should synthesize the project files.
NpmConfig
File representing the local NPM config in .npmrc.
Initializers
import { javascript } from 'projen'
new javascript.NpmConfig(project: NodeProject, options?: NpmConfigOptions)
Name | Type | Description |
---|---|---|
|
| No description. |
|
| No description. |
project
Required
- Type: NodeProject
options
Optional
- Type: NpmConfigOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| configure a generic property. |
| configure a scoped registry. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addConfig
public addConfig(name: string, value: string): void
configure a generic property.
name
Required
- Type: string
the name of the property.
value
Required
- Type: string
the value of the property.
addRegistry
public addRegistry(url: string, scope?: string): void
configure a scoped registry.
url
Required
- Type: string
the URL of the registry to use.
scope
Optional
- Type: string
the scope the registry is used for;
leave empty for the default registry
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
isConstruct
import { javascript } from 'projen'
javascript.NpmConfig.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.NpmConfig.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
Prettier
Represents prettier configuration.
Initializers
import { javascript } from 'projen'
new javascript.Prettier(project: NodeProject, options: PrettierOptions)
Name | Type | Description |
---|---|---|
|
| No description. |
|
| No description. |
project
Required
- Type: NodeProject
options
Required
- Type: PrettierOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore. |
| Add a prettier override. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addIgnorePattern
public addIgnorePattern(pattern: string): void
Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
pattern
Required
- Type: string
filepatterns so exclude from prettier formatting.
addOverride
public addOverride(override: PrettierOverride): void
Add a prettier override.
https://prettier.io/docs/en/configuration.html#configuration-overrides
override
Required
- Type: PrettierOverride
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
| No description. |
isConstruct
import { javascript } from 'projen'
javascript.Prettier.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.Prettier.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.Prettier.of(project: Project)
project
Required
- Type: projen.Project
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
|
| Returns all Prettier overrides. |
|
| Direct access to the prettier settings. |
| projen.IgnoreFile | The .prettierIgnore file. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
overrides
Required
public readonly overrides: PrettierOverride[];
- Type: PrettierOverride[]
Returns all Prettier overrides.
settings
Required
public readonly settings: PrettierSettings;
- Type: PrettierSettings
Direct access to the prettier settings.
ignoreFile
Optional
public readonly ignoreFile: IgnoreFile;
- Type: projen.IgnoreFile
The .prettierIgnore file.
Projenrc
A projenrc file written in JavaScript.
This component can be instantiated in any type of project and has no expectations around the project's main language.
Initializers
import { javascript } from 'projen'
new javascript.Projenrc(project: Project, options?: ProjenrcOptions)
Name | Type | Description |
---|---|---|
| projen.Project | No description. |
|
| No description. |
project
Required
- Type: projen.Project
options
Optional
- Type: ProjenrcOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
| Returns the Projenrc instance associated with a project or undefined if there is no Projenrc. |
isConstruct
import { javascript } from 'projen'
javascript.Projenrc.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.Projenrc.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
of
import { javascript } from 'projen'
javascript.Projenrc.of(project: Project)
Returns the Projenrc
instance associated with a project or undefined
if there is no Projenrc.
project
Required
- Type: projen.Project
The project.
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| string | The path of the projenrc file. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
filePath
Required
public readonly filePath: string;
- Type: string
The path of the projenrc file.
TypescriptConfig
Initializers
import { javascript } from 'projen'
new javascript.TypescriptConfig(project: Project, options: TypescriptConfigOptions)
Name | Type | Description |
---|---|---|
| projen.Project | No description. |
|
| No description. |
project
Required
- Type: projen.Project
options
Required
- Type: TypescriptConfigOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| Add an exclude pattern to the exclude array of the TSConfig. |
| Extend from base TypescriptConfig instance. |
| Add an include pattern to the include array of the TSConfig. |
| Remove an exclude pattern from the exclude array of the TSConfig. |
| Remove an include pattern from the include array of the TSConfig. |
| Resolve valid TypeScript extends paths relative to this config. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addExclude
public addExclude(pattern: string): void
Add an exclude pattern to the exclude
array of the TSConfig.
pattern
Required
- Type: string
The pattern to add.
addExtends
public addExtends(value: TypescriptConfig): void
Extend from base TypescriptConfig
instance.
value
Required
- Type: TypescriptConfig
Base TypescriptConfig
instance.
addInclude
public addInclude(pattern: string): void
Add an include pattern to the include
array of the TSConfig.
pattern
Required
- Type: string
The pattern to add.
removeExclude
public removeExclude(pattern: string): void
Remove an exclude pattern from the exclude
array of the TSConfig.
pattern
Required
- Type: string
The pattern to remove.
removeInclude
public removeInclude(pattern: string): void
Remove an include pattern from the include
array of the TSConfig.
pattern
Required
- Type: string
The pattern to remove.
resolveExtendsPath
public resolveExtendsPath(configPath: string): string
Resolve valid TypeScript extends paths relative to this config.
configPath
Required
- Type: string
Path to resolve against.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
isConstruct
import { javascript } from 'projen'
javascript.TypescriptConfig.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.TypescriptConfig.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| string[] | No description. |
| string[] | Array of base tsconfig.json paths. Any absolute paths are resolved relative to this instance, while any relative paths are used as is. |
| projen.JsonFile | No description. |
| string | No description. |
| string[] | No description. |
|
| No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
exclude
Required
public readonly exclude: string[];
- Type: string[]
extends
Required
public readonly extends: string[];
- Type: string[]
Array of base tsconfig.json
paths. Any absolute paths are resolved relative to this instance, while any relative paths are used as is.
file
Required
public readonly file: JsonFile;
- Type: projen.JsonFile
fileName
Required
public readonly fileName: string;
- Type: string
include
Required
public readonly include: string[];
- Type: string[]
compilerOptions
Optional
public readonly compilerOptions: TypeScriptCompilerOptions;
UpgradeDependencies
Upgrade node project dependencies.
Initializers
import { javascript } from 'projen'
new javascript.UpgradeDependencies(project: NodeProject, options?: UpgradeDependenciesOptions)
Name | Type | Description |
---|---|---|
|
| No description. |
|
| No description. |
project
Required
- Type: NodeProject
options
Optional
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
| Add steps to execute a successful build. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
addPostBuildSteps
public addPostBuildSteps(steps: ...JobStep[]): void
Add steps to execute a successful build.
steps
Required
- Type: ...projen.github.workflows.JobStep[]
workflow steps.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
isConstruct
import { javascript } from 'projen'
javascript.UpgradeDependencies.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.UpgradeDependencies.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
| projen.Task | A task run after the upgrade task. |
| projen.Task | The upgrade task. |
| projen.github.GithubWorkflow[] | The workflows that execute the upgrades. |
| projen.github.workflows.ContainerOptions | Container definitions for the upgrade workflow. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
postUpgradeTask
Required
public readonly postUpgradeTask: Task;
- Type: projen.Task
A task run after the upgrade task.
upgradeTask
Required
public readonly upgradeTask: Task;
- Type: projen.Task
The upgrade task.
workflows
Required
public readonly workflows: GithubWorkflow[];
- Type: projen.github.GithubWorkflow[]
The workflows that execute the upgrades.
One workflow per branch.
containerOptions
Optional
public readonly containerOptions: ContainerOptions;
- Type: projen.github.workflows.ContainerOptions
Container definitions for the upgrade workflow.
Yarnrc
Initializers
import { javascript } from 'projen'
new javascript.Yarnrc(project: Project, version: string, options?: YarnrcOptions)
Name | Type | Description |
---|---|---|
| projen.Project | No description. |
| string | No description. |
|
| No description. |
project
Required
- Type: projen.Project
version
Required
- Type: string
options
Optional
- Type: YarnrcOptions
Methods
Name | Description |
---|---|
| Returns a string representation of this construct. |
| Called after synthesis. |
| Called before synthesis. |
| Synthesizes files to the project output directory. |
toString
public toString(): string
Returns a string representation of this construct.
postSynthesize
public postSynthesize(): void
Called after synthesis.
Order is not guaranteed.
preSynthesize
public preSynthesize(): void
Called before synthesis.
synthesize
public synthesize(): void
Synthesizes files to the project output directory.
Static Functions
Name | Description |
---|---|
| Checks if x is a construct. |
| Test whether the given construct is a component. |
isConstruct
import { javascript } from 'projen'
javascript.Yarnrc.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
x
Required
- Type: any
Any object.
isComponent
import { javascript } from 'projen'
javascript.Yarnrc.isComponent(x: any)
Test whether the given construct is a component.
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
| constructs.Node | The tree node. |
| projen.Project | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
project
Required
public readonly project: Project;
- Type: projen.Project
Structs
AddBundleOptions
Options for addBundle()
.
Initializer
import { javascript } from 'projen'
const addBundleOptions: javascript.AddBundleOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| string[] | You can mark a file or a package as external to exclude it from your build. |
| boolean | Include a source map in the bundle. |
| boolean | In addition to the bundle:xyz task, creates bundle:xyz:watch task which will invoke the same esbuild command with the --watch flag. |
| string | esbuild platform. |
| string | esbuild target. |
| string | Use this to insert an arbitrary string at the beginning of generated JavaScript files. |
|
| The charset to use for esbuild's output. |
| {[ key: string ]: string} | Replace global identifiers with constant expressions. |
| {[ key: string ]: string | boolean} | Build arguments to pass into esbuild. |
| boolean | Mark the output file as executable. |
| string | Use this to insert an arbitrary string at the end of generated JavaScript files. |
| string | Output format for the generated JavaScript files. |
| string[] | This option allows you to automatically replace a global variable with an import from another file. |
| boolean | Whether to preserve the original name values even in minified code. |
| {[ key: string ]: string} | Map of file extensions (without dot) and loaders to use for this file type. |
|
| Log level for esbuild. |
| string[] | How to determine the entry point for modules. |
| boolean | This option tells esbuild to write out a JSON file relative to output directory with metadata about the build. |
| boolean | Whether to minify files when bundling. |
| string | Bundler output path relative to the asset's output directory. |
|
| Source map mode to be used when bundling. |
| boolean | Whether to include original source code in source maps when bundling. |
| string | The path of the tsconfig.json file to use for bundling. |
externals
Optional
public readonly externals: string[];
- Type: string[]
- Default: []
You can mark a file or a package as external to exclude it from your build.
Instead of being bundled, the import will be preserved (using require for the iife and cjs formats and using import for the esm format) and will be evaluated at run time instead.
This has several uses. First of all, it can be used to trim unnecessary code from your bundle for a code path that you know will never be executed. For example, a package may contain code that only runs in node but you will only be using that package in the browser. It can also be used to import code in node at run time from a package that cannot be bundled. For example, the fsevents package contains a native extension, which esbuild doesn't support.
sourcemap
Optional
public readonly sourcemap: boolean;
- Type: boolean
- Default: false
Include a source map in the bundle.
watchTask
Optional
public readonly watchTask: boolean;
- Type: boolean
- Default: true
In addition to the bundle:xyz
task, creates bundle:xyz:watch
task which will invoke the same esbuild command with the --watch
flag.
This can be used to continusouly watch for changes.
platform
Required
public readonly platform: string;
- Type: string
esbuild platform.
Example
"node"
target
Required
public readonly target: string;
- Type: string
esbuild target.
Example
"node12"
banner
Optional
public readonly banner: string;
- Type: string
- Default: no comments are passed
Use this to insert an arbitrary string at the beginning of generated JavaScript files.
This is similar to footer which inserts at the end instead of the beginning.
This is commonly used to insert comments:
charset
Optional
public readonly charset: Charset;
- Type: Charset
- Default: Charset.ASCII
The charset to use for esbuild's output.
By default esbuild's output is ASCII-only. Any non-ASCII characters are escaped
using backslash escape sequences. Using escape sequences makes the generated output
slightly bigger, and also makes it harder to read. If you would like for esbuild to print
the original characters without using escape sequences, use Charset.UTF8
.
define
Optional
public readonly define: {[ key: string ]: string};
- Type: {[ key: string ]: string}
- Default: no replacements are made
Replace global identifiers with constant expressions.
For example, { 'process.env.DEBUG': 'true' }
.
Another example, { 'process.env.API_KEY': JSON.stringify('xxx-xxxx-xxx') }
.
esbuildArgs
Optional
public readonly esbuildArgs: {[ key: string ]: string | boolean};
- Type: {[ key: string ]: string | boolean}
- Default: no additional esbuild arguments are passed
Build arguments to pass into esbuild.
For example, to add the --log-limit flag:
project.bundler.addBundle("./src/hello.ts", {
platform: "node",
target: "node18",
sourcemap: true,
format: "esm",
esbuildArgs: {
"--log-limit": "0",
},
});
executable
Optional
public readonly executable: boolean;
- Type: boolean
- Default: false
Mark the output file as executable.
footer
Optional
public readonly footer: string;
- Type: string
- Default: no comments are passed
Use this to insert an arbitrary string at the end of generated JavaScript files.
This is similar to banner which inserts at the beginning instead of the end.
This is commonly used to insert comments
format
Optional
public readonly format: string;
- Type: string
- Default: undefined
Output format for the generated JavaScript files.
There are currently three possible values that can be configured: "iife"
, "cjs"
, and "esm"
.
If not set (undefined
), esbuild picks an output format for you based on platform
:
"cjs"
ifplatform
is"node"
"iife"
ifplatform
is"browser"
"esm"
ifplatform
is"neutral"
Note: If making a bundle to run under node with ESM, set format
to "esm"
instead of setting platform
to "neutral"
.
inject
Optional
public readonly inject: string[];
- Type: string[]
- Default: no code is injected
This option allows you to automatically replace a global variable with an import from another file.
keepNames
Optional
public readonly keepNames: boolean;
- Type: boolean
- Default: false
Whether to preserve the original name
values even in minified code.
In JavaScript the name
property on functions and classes defaults to a
nearby identifier in the source code.
However, minification renames symbols to reduce code size and bundling
sometimes need to rename symbols to avoid collisions. That changes value of
the name
property for many of these cases. This is usually fine because
the name
property is normally only used for debugging. However, some
frameworks rely on the name
property for registration and binding purposes.
If this is the case, you can enable this option to preserve the original
name
values even in minified code.
loaders
Optional
public readonly loaders: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Map of file extensions (without dot) and loaders to use for this file type.
Loaders are appended to the esbuild command by --loader:.extension=loader
logLevel
Optional
public readonly logLevel: BundleLogLevel;
- Type: BundleLogLevel
- Default: LogLevel.WARNING
Log level for esbuild.
This is also propagated to the package manager and applies to its specific install command.
mainFields
Optional
public readonly mainFields: string[];
- Type: string[]
- Default: []
How to determine the entry point for modules.
Try ['module', 'main'] to default to ES module versions.
metafile
Optional
public readonly metafile: boolean;
- Type: boolean
- Default: false
This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
The metadata in this JSON file follows this schema (specified using TypeScript syntax):
{
outputs: {
[path: string]: {
bytes: number
inputs: {
[path: string]: { bytesInOutput: number }
}
imports: { path: string }[]
exports: string[]
}
}
}
This data can then be analyzed by other tools. For example, bundle buddy can consume esbuild's metadata format and generates a treemap visualization of the modules in your bundle and how much space each one takes up.
minify
Optional
public readonly minify: boolean;
- Type: boolean
- Default: false
Whether to minify files when bundling.
outfile
Optional
public readonly outfile: string;
- Type: string
- Default: "index.js"
Bundler output path relative to the asset's output directory.
sourceMapMode
Optional
public readonly sourceMapMode: SourceMapMode;
- Type: SourceMapMode
- Default: SourceMapMode.DEFAULT
Source map mode to be used when bundling.
sourcesContent
Optional
public readonly sourcesContent: boolean;
- Type: boolean
- Default: true
Whether to include original source code in source maps when bundling.
tsconfigPath
Optional
public readonly tsconfigPath: string;
- Type: string
- Default: "tsconfig.json"
The path of the tsconfig.json file to use for bundling.
BuildWorkflowOptions
Build workflow options for NodeProject.
Initializer
import { javascript } from 'projen'
const buildWorkflowOptions: javascript.BuildWorkflowOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| string | Name of the buildfile (e.g. "build" becomes "build.yml"). |
| projen.github.workflows.JobPermissions | Permissions granted to the build job To limit job permissions for contents , the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE } . |
| projen.github.workflows.JobStep[] | Steps to execute before the build. |
| projen.github.workflows.Triggers | Build workflow triggers. |
| boolean | Automatically update files modified during builds to pull-request branches. |
name
Optional
public readonly name: string;
- Type: string
- Default: "build"
Name of the buildfile (e.g. "build" becomes "build.yml").
permissions
Optional
public readonly permissions: JobPermissions;
- Type: projen.github.workflows.JobPermissions
- Default:
{ contents: JobPermission.WRITE }
Permissions granted to the build job To limit job permissions for contents
, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }
.
preBuildSteps
Optional
public readonly preBuildSteps: JobStep[];
- Type: projen.github.workflows.JobStep[]
- Default: []
Steps to execute before the build.
workflowTriggers
Optional
public readonly workflowTriggers: Triggers;
- Type: projen.github.workflows.Triggers
- Default: "{ pullRequest: {}, workflowDispatch: {} }"
Build workflow triggers.
mutableBuild
Optional
public readonly mutableBuild: boolean;
- Type: boolean
- Default: true
Automatically update files modified during builds to pull-request branches.
This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
Bundle
Initializer
import { javascript } from 'projen'
const bundle: javascript.Bundle = { ... }
Properties
Name | Type | Description |
---|---|---|
| projen.Task | The task that produces this bundle. |
| string | Base directory containing the output file (relative to project root). |
| string | Location of the output file (relative to project root). |
| projen.Task | The "watch" task for this bundle. |
bundleTask
Required
public readonly bundleTask: Task;
- Type: projen.Task
The task that produces this bundle.
outdir
Required
public readonly outdir: string;
- Type: string
Base directory containing the output file (relative to project root).
outfile
Required
public readonly outfile: string;
- Type: string
Location of the output file (relative to project root).
watchTask
Optional
public readonly watchTask: Task;
- Type: projen.Task
The "watch" task for this bundle.
BundlerOptions
Options for Bundler
.
Initializer
import { javascript } from 'projen'
const bundlerOptions: javascript.BundlerOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| boolean | Install the bundle command as a pre-compile phase. |
| string | Output directory for all bundles. |
| string | The semantic version requirement for esbuild . |
| {[ key: string ]: string} | Map of file extensions (without dot) and loaders to use for this file type. |
|
| Choose which phase (if any) to add the bundle command to. |
addToPreCompile
Optional
addToPreCompile
- Deprecated: Use
runBundleTask
instead.
public readonly addToPreCompile: boolean;
- Type: boolean
- Default: true
Install the bundle
command as a pre-compile phase.
assetsDir
Optional
public readonly assetsDir: string;
- Type: string
- Default: "assets"
Output directory for all bundles.
esbuildVersion
Optional
public readonly esbuildVersion: string;
- Type: string
- Default: no specific version (implies latest)
The semantic version requirement for esbuild
.
loaders
Optional
public readonly loaders: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Map of file extensions (without dot) and loaders to use for this file type.
Loaders are appended to the esbuild command by --loader:.extension=loader
runBundleTask
Optional
public readonly runBundleTask: RunBundleTask;
- Type: RunBundleTask
- Default: RunBundleTask.PRE_COMPILE
Choose which phase (if any) to add the bundle
command to.
Note: If using addBundle()
with the bundleCompiledResults
, this option
must be set to RunBundleTask.POST_COMPILE
or RunBundleTask.MANUAL
.
[AddBundleOptions.bundleCompiledResults *](AddBundleOptions.bundleCompiledResults *)
BundlingOptions
Options for bundling.
Initializer
import { javascript } from 'projen'
const bundlingOptions: javascript.BundlingOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| string[] | You can mark a file or a package as external to exclude it from your build. |
| boolean | Include a source map in the bundle. |
| boolean | In addition to the bundle:xyz task, creates bundle:xyz:watch task which will invoke the same esbuild command with the --watch flag. |
externals
Optional
public readonly externals: string[];
- Type: string[]
- Default: []
You can mark a file or a package as external to exclude it from your build.
Instead of being bundled, the import will be preserved (using require for the iife and cjs formats and using import for the esm format) and will be evaluated at run time instead.
This has several uses. First of all, it can be used to trim unnecessary code from your bundle for a code path that you know will never be executed. For example, a package may contain code that only runs in node but you will only be using that package in the browser. It can also be used to import code in node at run time from a package that cannot be bundled. For example, the fsevents package contains a native extension, which esbuild doesn't support.
sourcemap
Optional
public readonly sourcemap: boolean;
- Type: boolean
- Default: false
Include a source map in the bundle.
watchTask
Optional
public readonly watchTask: boolean;
- Type: boolean
- Default: true
In addition to the bundle:xyz
task, creates bundle:xyz:watch
task which will invoke the same esbuild command with the --watch
flag.
This can be used to continusouly watch for changes.
CodeArtifactOptions
Options for publishing npm packages to AWS CodeArtifact.
Initializer
import { javascript } from 'projen'
const codeArtifactOptions: javascript.CodeArtifactOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| string | GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact. |
|
| Provider to use for authorizing requests to AWS CodeArtifact. |
| string | ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (registry contains AWS CodeArtifact URL). |
| string | GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact. |
accessKeyIdSecret
Optional
public readonly accessKeyIdSecret: string;
- Type: string
- Default: When the
authProvider
value is set toCodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR
, the default is "AWS_ACCESS_KEY_ID". ForCodeArtifactAuthProvider.GITHUB_OIDC
, this value must be left undefined.
GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl
contains AWS CodeArtifact URL).
authProvider
Optional
public readonly authProvider: CodeArtifactAuthProvider;
- Type: CodeArtifactAuthProvider
- Default: CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR
Provider to use for authorizing requests to AWS CodeArtifact.
roleToAssume
Optional
public readonly roleToAssume: string;
- Type: string
- Default: undefined
ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (registry
contains AWS CodeArtifact URL).
When using the CodeArtifactAuthProvider.GITHUB_OIDC
auth provider, this value must be defined.
secretAccessKeySecret
Optional
public readonly secretAccessKeySecret: string;
- Type: string
- Default: When the
authProvider
value is set toCodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR
, the default is "AWS_SECRET_ACCESS_KEY". ForCodeArtifactAuthProvider.GITHUB_OIDC
, this value must be left undefined.
GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.
This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl
contains AWS CodeArtifact URL).
CoverageThreshold
Initializer
import { javascript } from 'projen'
const coverageThreshold: javascript.CoverageThreshold = { ... }
Properties
Name | Type | Description |
---|---|---|
| number | No description. |
| number | No description. |
| number | No description. |
| number | No description. |
branches
Optional
public readonly branches: number;
- Type: number
functions
Optional
public readonly functions: number;
- Type: number
lines
Optional
public readonly lines: number;
- Type: number
statements
Optional
public readonly statements: number;
- Type: number
EslintCommandOptions
Initializer
import { javascript } from 'projen'
const eslintCommandOptions: javascript.EslintCommandOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| string[] | Extra flag arguments to pass to eslint command. |
| boolean | Whether to fix eslint issues when running the eslint task. |
extraArgs
Optional
public readonly extraArgs: string[];
- Type: string[]
Extra flag arguments to pass to eslint command.
fix
Optional
public readonly fix: boolean;
- Type: boolean
- Default: true
Whether to fix eslint issues when running the eslint task.
EslintOptions
Initializer
import { javascript } from 'projen'
const eslintOptions: javascript.EslintOptions = { ... }
Properties
Name | Type | Description |
---|---|---|
| string[] | Files or glob patterns or directories with source files to lint (e.g. [ "src" ]). |
| string[] | Enable import alias for module paths. |
| {[ key: string ]: string} | Enable import alias for module paths. |
|
| Options for eslint command executed by eslint task. |
| string[] | Files or glob patterns or directories with source files that include tests and build tools. |
| string[] | File types that should be linted (e.g. [ ".js", ".ts" ]). |
| string[] | List of file patterns that should not be linted, using the same syntax as .gitignore patterns. |
| boolean | Should we lint .projenrc.js. |
| string | Projenrc file to lint. |
| boolean | Enable prettier for code formatting. |
| projen.ICompareString | The extends array in eslint is order dependent. |
| boolean | Always try to resolve types under <root>@types directory even it doesn't contain any source code. |
| string | Path to tsconfig.json which should be used by eslint. |
| boolean | Write eslint configuration as YAML instead of JSON. |
dirs
Required
public readonly dirs: string[];
- Type: string[]
Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).
aliasExtensions
Optional
public readonly aliasExtensions: string[];
- Type: string[]
- Default: undefined
Enable import alias for module paths.
aliasMap
Optional
public readonly aliasMap: {[ key: string ]: string};
- Type: {[ key: string ]: string}
- Default: undefined
Enable import alias for module paths.
commandOptions
Optional
public readonly commandOptions: EslintCommandOptions;
- Type: EslintCommandOptions
Options for eslint command executed by eslint task.
devdirs
Optional
public readonly devdirs: string[];
- Type: string[]
- Default: []
Files or glob patterns or directories with source files that include tests and build tools.
These sources are linted but may also import packages from devDependencies
.
fileExtensions
Optional
public readonly fileExtensions: string[];
- Type: string[]
- Default: [".ts"]
File types that should be linted (e.g. [ ".js", ".ts" ]).
ignorePatterns
Optional
public readonly ignorePatterns: string[];
- Type: string[]
- Default: [ '.js', '.d.ts', 'node_modules/', '*.generated.ts', 'coverage' ]
List of file patterns that should not be linted, using the same syntax as .gitignore patterns.
lintProjenRc
Optional
lintProjenRc
- Deprecated: set to
false
to remove any automatic rules and add manually
public readonly lintProjenRc: boolean;
- Type: boolean
- Default: true
Should we lint .projenrc.js.
lintProjenRcFile
Optional
lintProjenRcFile
- Deprecated: provide as
devdirs
public readonly lintProjenRcFile: string;
- Type: string
- Default: "projenrc.js"
Projenrc file to lint.
Use empty string to disable.
prettier
Optional
public readonly prettier: boolean;
- Type: boolean
- Default: false
Enable prettier for code formatting.
sortExtends
Optional
public readonly sortExtends: ICompareString;
- Type: projen.ICompareString
- Default: Use known ESLint best practices to place "prettier" plugins at the end of the array
The extends array in eslint is order dependent.
This option allows to sort the extends array in any way seen fit.
tsAlwaysTryTypes
Optional
public readonly tsAlwaysTryTypes: boolean;
- Type: boolean
- Default: true
Always try to resolve types under <root>@types
directory even it doesn't contain any source code.
This prevents import/no-unresolved
eslint errors when importing a @types/*
module that would otherwise remain unresolved.
tsconfigPath
Optional
public readonly tsconfigPath: string;
- Type: string
- Default: "./tsconfig.json"
Path to tsconfig.json
which should be used by eslint.
yaml
Optional
public readonly yaml: boolean;
- Type: boolean
- Default: false
Write eslint configuration as YAML instead of JSON.
EslintOverride
eslint rules override.
Initializer
import { javascript } from 'projen'
const eslintOverride: javascript.EslintOverride = { ... }
Properties
Name | Type | Description |
---|---|---|
| string[] | Files or file patterns on which to apply the override. |
| string[] | Pattern(s) to exclude from this override. |
| string[] | Config(s) to extend in this override. |
| string | The overridden parser. |
| string[] | plugins override. |
| {[ key: string ]: any} | The overridden rules. |
files
Required
public readonly files: string[];
- Type: string[]
Files or file patterns on which to apply the override.
excludedFiles
Optional
public readonly excludedFiles: string[];
- Type: string[]
Pattern(s) to exclude from this override.
If a file matches any of the excluded patterns, the configuration won’t apply.
extends
Optional
public readonly extends: string[];
- Type: string[]
Config(s) to extend in this override.
parser
Optional
public readonly parser: string;
- Type: string
The overridden parser.
plugins
Optional
public readonly plugins: string[];
- Type: string[]
plugins
override.
rules
Optional
public readonly rules: {[ key: string ]: any};
- Type: {[ key: string ]: any}
The overridden rules.
HasteConfig
Initializer
import { javascript } from 'projen'
const hasteConfig: javascript.HasteConfig = { ... }
Properties
Name | Type | Description |
---|---|---|
| boolean | No description. |