10.0.0 • Published 1 year ago

@stoplight/scripts v10.0.0

Weekly downloads
878
License
Apache-2.0
Repository
github
Last release
1 year ago

@stoplight/scripts

Maintainability Test Coverage

Usage

Create a new library:

npx @stoplight/scripts create:lib

Commands

sl-scripts build

Build source code

USAGE
  $ sl-scripts build [--verbose]

FLAGS
  --verbose  moar logs

DESCRIPTION
  Build source code

EXAMPLES
  $ sl-scripts build

See code: src/commands/build/index.ts

sl-scripts bundle

Bundle source code

USAGE
  $ sl-scripts bundle [--minify] [--verbose]

FLAGS
  --minify   minify output using terser
  --verbose  moar logs

DESCRIPTION
  Bundle source code

EXAMPLES
  $ sl-scripts bundle

See code: src/commands/bundle/index.ts

sl-scripts create:lib

Scaffold out a new library.

USAGE
  $ sl-scripts create:lib

DESCRIPTION
  Scaffold out a new library.

EXAMPLES
  $ sl-scripts create:lib

See code: src/commands/create/lib.ts

sl-scripts release

Publish new src or docs release.

USAGE
  $ sl-scripts release [--verbose]

FLAGS
  --verbose  moar logs

DESCRIPTION
  Publish new src or docs release.

EXAMPLES
  $ sl-scripts release

  $ sl-scripts release:docs

See code: src/commands/release/index.ts

sl-scripts release:docs

Push built docs to github pages.

USAGE
  $ sl-scripts release:docs [--dry-run] [--verbose]

FLAGS
  --dry-run  run the release process but do not publish
  --verbose  moar logs

DESCRIPTION
  Push built docs to github pages.

EXAMPLES
  $ sl-scripts release:docs

See code: src/commands/release/docs.ts

Overriding Configs

Jest

Simply create a jest.config.js file in the root of your project, and extend the default config. For example:

// ./jest.config.js
module.exports = {
  preset: '@stoplight/scripts',
};

TS

Simply create a tsconfig.json file in the root of your project, and extend the default config. For example:

// ./tsconfig.json
{
  "extends": "@stoplight/scripts/tsconfig.json",
  "include": ["src"],
  "compilerOptions": {
    "outDir": "dist"
  }
}

Semantic Release

Simply add a release property to your package.json file. For example:

// ./package.json
{
  // ... props
  "release": {
    "pkgRoot": "dist",
    "plugins": ["@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator"]
  }
  // ... props
}

Rollup

By default all dependencies and peerDependencies declared in your package.json will be treated as external deps during sl-scripts bundle. If you would like to always bundle a dep, list those deps in your package.json file like so:

{
  "name": "your-package",
  "version": "0.0.0",
  "rollup": {
    "bundleDeps": ["dep-1", "dep-2"]
  }
}
10.0.0

1 year ago

9.3.4

1 year ago

9.3.3

1 year ago

9.3.2

1 year ago

9.3.1

1 year ago

9.3.0

2 years ago

9.2.1

3 years ago

9.2.0

4 years ago

9.1.0

4 years ago

9.0.6

4 years ago

9.0.5

4 years ago

9.0.4

4 years ago

9.0.3

4 years ago

9.0.2

4 years ago

9.0.1

4 years ago

9.0.0

4 years ago

8.2.4

4 years ago

8.2.3

5 years ago

8.2.2

5 years ago

8.2.1

5 years ago

8.2.0

5 years ago

8.1.0

5 years ago

7.1.0

5 years ago

8.0.0

5 years ago

5.2.0-beta.0

6 years ago

7.0.4

6 years ago

7.0.3

6 years ago

7.0.2

6 years ago

7.0.1

6 years ago

7.0.0

6 years ago

6.0.1

6 years ago

6.0.0

6 years ago

5.1.0

6 years ago

5.0.0

6 years ago

4.3.0

6 years ago

4.2.1

6 years ago

4.2.0

6 years ago

4.1.0

6 years ago

4.0.0

7 years ago

3.1.1

7 years ago

3.1.0

7 years ago

3.0.2

7 years ago

3.0.1

7 years ago

3.0.0

7 years ago

2.0.0

7 years ago

1.2.3

7 years ago

1.2.2

7 years ago

1.2.1

7 years ago

1.2.0

7 years ago

1.1.3

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago