diff --git a/.changeset/blue-pianos-camp.md b/.changeset/blue-pianos-camp.md deleted file mode 100644 index df9e49507..000000000 --- a/.changeset/blue-pianos-camp.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Delete `test:build` and `test:jest` scripts diff --git a/.changeset/brown-chairs-occur.md b/.changeset/brown-chairs-occur.md deleted file mode 100644 index 492df654f..000000000 --- a/.changeset/brown-chairs-occur.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** List skuba upgrade upfront diff --git a/.changeset/chilly-islands-hang.md b/.changeset/chilly-islands-hang.md deleted file mode 100644 index 04622076b..000000000 --- a/.changeset/chilly-islands-hang.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** Avoid unnecessary file writes during templating diff --git a/.changeset/chilly-planes-mix.md b/.changeset/chilly-planes-mix.md deleted file mode 100644 index 99becd025..000000000 --- a/.changeset/chilly-planes-mix.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/lambda-sqs-worker:** Drop `hot-shots` dependency diff --git a/.changeset/chilly-wombats-notice.md b/.changeset/chilly-wombats-notice.md deleted file mode 100644 index bf730c349..000000000 --- a/.changeset/chilly-wombats-notice.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** Sort dependencies diff --git a/.changeset/cold-ghosts-poke.md b/.changeset/cold-ghosts-poke.md deleted file mode 100644 index 03457976b..000000000 --- a/.changeset/cold-ghosts-poke.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template:** Redact `Authorization` headers in logs diff --git a/.changeset/curly-walls-clean.md b/.changeset/curly-walls-clean.md deleted file mode 100644 index 6aec186f4..000000000 --- a/.changeset/curly-walls-clean.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/package:** Make prompt unskippable diff --git a/.changeset/cyan-papayas-swim.md b/.changeset/cyan-papayas-swim.md deleted file mode 100644 index f81628452..000000000 --- a/.changeset/cyan-papayas-swim.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init**: Exclude `lib-` directories from compilation diff --git a/.changeset/dry-ladybugs-admire.md b/.changeset/dry-ladybugs-admire.md deleted file mode 100644 index 4be72451c..000000000 --- a/.changeset/dry-ladybugs-admire.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/private-npm-package:** Fix ReferenceError on init diff --git a/.changeset/dull-oranges-sparkle.md b/.changeset/dull-oranges-sparkle.md deleted file mode 100644 index 03d2f8741..000000000 --- a/.changeset/dull-oranges-sparkle.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**help:** Show `build-package` correctly diff --git a/.changeset/eight-brooms-jog.md b/.changeset/eight-brooms-jog.md deleted file mode 100644 index 52053450b..000000000 --- a/.changeset/eight-brooms-jog.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Migrate `collectCoverageFrom` Jest option diff --git a/.changeset/empty-boats-cross.md b/.changeset/empty-boats-cross.md deleted file mode 100644 index ec964914e..000000000 --- a/.changeset/empty-boats-cross.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Tame newlines in ignore files diff --git a/.changeset/fair-teachers-sleep.md b/.changeset/fair-teachers-sleep.md deleted file mode 100644 index 4000c4603..000000000 --- a/.changeset/fair-teachers-sleep.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** List filtered devDependencies upfront diff --git a/.changeset/famous-carpets-matter.md b/.changeset/famous-carpets-matter.md deleted file mode 100644 index 71e9006e1..000000000 --- a/.changeset/famous-carpets-matter.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'skuba': minor ---- - -**configure:** Support migration from `seek-module-toolkit` - -`seek-module-toolkit` users can now install `skuba` and run `skuba configure` to migrate their configuration. - -Care should be taken around the [change in build directories](https://github.com/seek-oss/skuba/blob/master/docs/migrating-from-seek-module-toolkit.md#building). diff --git a/.changeset/five-glasses-do.md b/.changeset/five-glasses-do.md deleted file mode 100644 index d34c0e921..000000000 --- a/.changeset/five-glasses-do.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -'skuba': minor ---- - -**eslint:** skuba is now usable as a shareable config - -```javascript -// .eslintrc.js - -module.exports = { - // This can be used in place of require.resolve('skuba/config/eslint') - extends: ['skuba'], -}; -``` diff --git a/.changeset/happy-seals-push.md b/.changeset/happy-seals-push.md deleted file mode 100644 index 1d8e4c496..000000000 --- a/.changeset/happy-seals-push.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** `.dockerignore` the `.gantry` folder. This should decrease build times. diff --git a/.changeset/lazy-rings-double.md b/.changeset/lazy-rings-double.md deleted file mode 100644 index 3153b1998..000000000 --- a/.changeset/lazy-rings-double.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/koa-rest-api:** Ensure lint passes on init diff --git a/.changeset/lemon-pugs-grow.md b/.changeset/lemon-pugs-grow.md deleted file mode 100644 index d86830bec..000000000 --- a/.changeset/lemon-pugs-grow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Sort more `package.json` props diff --git a/.changeset/little-balloons-cheat.md b/.changeset/little-balloons-cheat.md deleted file mode 100644 index c879b3d47..000000000 --- a/.changeset/little-balloons-cheat.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**init:** Install matching skuba version diff --git a/.changeset/long-cows-sit.md b/.changeset/long-cows-sit.md deleted file mode 100644 index 7370d5dc4..000000000 --- a/.changeset/long-cows-sit.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**init:** Extend validation on initial GitHub fields diff --git a/.changeset/loud-horses-occur.md b/.changeset/loud-horses-occur.md deleted file mode 100644 index 169b602b6..000000000 --- a/.changeset/loud-horses-occur.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/package:** Drop module aliasing from `tsconfig.json` diff --git a/.changeset/lovely-fishes-notice.md b/.changeset/lovely-fishes-notice.md deleted file mode 100644 index 0b7863e7c..000000000 --- a/.changeset/lovely-fishes-notice.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template:** Redact `err.config.sockets` from logs diff --git a/.changeset/neat-pigs-exist.md b/.changeset/neat-pigs-exist.md deleted file mode 100644 index 8eab6bc21..000000000 --- a/.changeset/neat-pigs-exist.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/koa-rest-api:** Support improved Runtypes error messaging diff --git a/.changeset/plenty-garlics-refuse.md b/.changeset/plenty-garlics-refuse.md deleted file mode 100644 index 9d0ee7481..000000000 --- a/.changeset/plenty-garlics-refuse.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Handle `skuba-dive` dependency upfront diff --git a/.changeset/polite-brooms-flow.md b/.changeset/polite-brooms-flow.md deleted file mode 100644 index 58e9e8a1c..000000000 --- a/.changeset/polite-brooms-flow.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'skuba': minor ---- - -**build, start:** Support experimental Babel toolchain - -You can now build your project with Babel instead of tsc. Experimentally. - -See [docs/babel.md](https://github.com/seek-oss/skuba/tree/master/docs/babel.md) for details. diff --git a/.changeset/popular-clouds-train.md b/.changeset/popular-clouds-train.md deleted file mode 100644 index 90b388f26..000000000 --- a/.changeset/popular-clouds-train.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Migrate select Jest options diff --git a/.changeset/pretty-dragons-know.md b/.changeset/pretty-dragons-know.md deleted file mode 100644 index 419bd47a2..000000000 --- a/.changeset/pretty-dragons-know.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Reserve skuba-managed sections in ignore files diff --git a/.changeset/rich-lemons-crash.md b/.changeset/rich-lemons-crash.md deleted file mode 100644 index 8cc9c582f..000000000 --- a/.changeset/rich-lemons-crash.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** `.gitignore` archives created by `npm pack` diff --git a/.changeset/sixty-otters-prove.md b/.changeset/sixty-otters-prove.md deleted file mode 100644 index e9a4da8be..000000000 --- a/.changeset/sixty-otters-prove.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -'skuba': minor ---- - -**jest:** skuba is now usable as a preset - -```javascript -// jest.config.js - -const { testPathIgnorePatterns } = require('skuba/config/jest'); - -module.exports = { - // This can be used in place of ...require('skuba/config/jest') - preset: 'skuba', - - // This is still necessary as Jest doesn't deep-merge presets - testPathIgnorePatterns: [...testPathIgnorePatterns, '/test\\.ts'], -}; -``` diff --git a/.changeset/small-penguins-change.md b/.changeset/small-penguins-change.md deleted file mode 100644 index 3a24d58cc..000000000 --- a/.changeset/small-penguins-change.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/private-npm-package:** Include a half-decent README diff --git a/.changeset/smart-crews-appear.md b/.changeset/smart-crews-appear.md deleted file mode 100644 index ca90b08ee..000000000 --- a/.changeset/smart-crews-appear.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** Make mentioned commands actually runnable diff --git a/.changeset/soft-cars-compete.md b/.changeset/soft-cars-compete.md deleted file mode 100644 index 70828abea..000000000 --- a/.changeset/soft-cars-compete.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -'skuba': minor ---- - -**configure:** Replace relocated dependencies - -`skuba configure` now replaces the following dependencies and updates their import paths via naive find-and-replace: - -- `@seek/koala → seek-koala` -- `@seek/node-datadog-custom-metrics → seek-datadog-custom-metrics` -- `@seek/skuba → skuba` -- `@seek/skuba-dive → skuba-dive` diff --git a/.changeset/spicy-jeans-remember.md b/.changeset/spicy-jeans-remember.md deleted file mode 100644 index b89c3de63..000000000 --- a/.changeset/spicy-jeans-remember.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Clean up ignore files during migration diff --git a/.changeset/stale-jeans-peel.md b/.changeset/stale-jeans-peel.md deleted file mode 100644 index eb9d8dc56..000000000 --- a/.changeset/stale-jeans-peel.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': minor ---- - -**init:** Commit initial template files and configure default remote diff --git a/.changeset/stupid-apples-exist.md b/.changeset/stupid-apples-exist.md deleted file mode 100644 index 0db1b705d..000000000 --- a/.changeset/stupid-apples-exist.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': minor ---- - -**format, lint:** Enforce TSDoc syntax diff --git a/.changeset/swift-dryers-watch.md b/.changeset/swift-dryers-watch.md deleted file mode 100644 index dda7559ea..000000000 --- a/.changeset/swift-dryers-watch.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'skuba': minor ---- - -**template/oss-npm-package:** Add new template - -This is intended for [seek-oss](https://github.com/seek-oss) projects. diff --git a/.changeset/tame-mangos-lie.md b/.changeset/tame-mangos-lie.md deleted file mode 100644 index 4a3bd63ca..000000000 --- a/.changeset/tame-mangos-lie.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** `.dockerignore` the `.git` folder. This should decrease build times. diff --git a/.changeset/thin-tigers-hunt.md b/.changeset/thin-tigers-hunt.md deleted file mode 100644 index 9b6accfb6..000000000 --- a/.changeset/thin-tigers-hunt.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Add notice for smt migrations diff --git a/.changeset/thirty-bananas-build.md b/.changeset/thirty-bananas-build.md deleted file mode 100644 index 1a6dbbd43..000000000 --- a/.changeset/thirty-bananas-build.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**cli:** Suppress dependency deprecation warnings diff --git a/.changeset/tidy-lamps-develop.md b/.changeset/tidy-lamps-develop.md deleted file mode 100644 index d1a963220..000000000 --- a/.changeset/tidy-lamps-develop.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure:** Delete `.npmignore` diff --git a/.changeset/warm-radios-help.md b/.changeset/warm-radios-help.md deleted file mode 100644 index 35386d181..000000000 --- a/.changeset/warm-radios-help.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template:** Drop duplicate team name prompt diff --git a/.changeset/wet-kings-pay.md b/.changeset/wet-kings-pay.md deleted file mode 100644 index a617435a4..000000000 --- a/.changeset/wet-kings-pay.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**template/koa-rest-api:** Use Koala's error handler diff --git a/.changeset/young-deers-rescue.md b/.changeset/young-deers-rescue.md deleted file mode 100644 index 555aa09ae..000000000 --- a/.changeset/young-deers-rescue.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -**configure, init:** Reduce unintended stripping of `_` filename prefix diff --git a/CHANGELOG.md b/CHANGELOG.md index 38db2d108..46230af26 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,101 @@ # skuba +## 3.7.0 + +### Minor Changes + +- 7a967cd: **configure:** Support migration from `seek-module-toolkit` + + `seek-module-toolkit` users can now install `skuba` and run `skuba configure` to migrate their configuration. + + Care should be taken around the [change in build directories](https://github.com/seek-oss/skuba/blob/master/docs/migrating-from-seek-module-toolkit.md#building). + +- f2f3925: **eslint:** skuba is now usable as a shareable config + + ```javascript + // .eslintrc.js + + module.exports = { + // This can be used in place of require.resolve('skuba/config/eslint') + extends: ['skuba'], + }; + ``` + +- 03a7ac2: **build, start:** Support experimental Babel toolchain + + You can now build your project with Babel instead of tsc. Experimentally. + + See [docs/babel.md](https://github.com/seek-oss/skuba/tree/master/docs/babel.md) for details. + +- b23bd23: **jest:** skuba is now usable as a preset + + ```javascript + // jest.config.js + + const { testPathIgnorePatterns } = require('skuba/config/jest'); + + module.exports = { + // This can be used in place of ...require('skuba/config/jest') + preset: 'skuba', + + // This is still necessary as Jest doesn't deep-merge presets + testPathIgnorePatterns: [...testPathIgnorePatterns, '/test\\.ts'], + }; + ``` + +- 5c138fb: **configure:** Replace relocated dependencies + + `skuba configure` now replaces the following dependencies and updates their import paths via naive find-and-replace: + + - `@seek/koala → seek-koala` + - `@seek/node-datadog-custom-metrics → seek-datadog-custom-metrics` + - `@seek/skuba → skuba` + - `@seek/skuba-dive → skuba-dive` + +- b85b4b3: **init:** Commit initial template files and configure default remote +- cbce20b: **format, lint:** Enforce TSDoc syntax +- f39abdc: **template/oss-npm-package:** Add new template + + This is intended for [seek-oss](https://github.com/seek-oss) projects. + +### Patch Changes + +- 205f27d: **configure:** Delete `test:build` and `test:jest` scripts +- 0cbe50e: **configure:** List skuba upgrade upfront +- 5ec72d5: **configure, init:** Avoid unnecessary file writes during templating +- 5753b38: **template/lambda-sqs-worker:** Drop `hot-shots` dependency +- 0c1e129: **configure, init:** Sort dependencies +- 93cdf6c: **template:** Redact `Authorization` headers in logs +- 1b9b9c4: **template/package:** Make prompt unskippable +- 5283618: **configure, init**: Exclude `lib-` directories from compilation +- 676030a: **template/private-npm-package:** Fix ReferenceError on init +- f36b136: **help:** Show `build-package` correctly +- 1b7641f: **configure:** Migrate `collectCoverageFrom` Jest option +- 967603c: **configure:** Tame newlines in ignore files +- 9edfd74: **configure:** List filtered devDependencies upfront +- 8f862f5: **configure, init:** `.dockerignore` the `.gantry` folder. This should decrease build times. +- 14e7b92: **template/koa-rest-api:** Ensure lint passes on init +- 35b4b2e: **configure:** Sort more `package.json` props +- 23d4e09: **init:** Install matching skuba version +- bac749a: **init:** Extend validation on initial GitHub fields +- cbce20b: **template/package:** Drop module aliasing from `tsconfig.json` +- b480dac: **template:** Redact `err.config.sockets` from logs +- a52b995: **template/koa-rest-api:** Support improved Runtypes error messaging +- 1fbb097: **configure:** Handle `skuba-dive` dependency upfront +- fe86bdf: **configure:** Migrate select Jest options +- 72c2e2c: **configure:** Reserve skuba-managed sections in ignore files +- 77744b7: **configure, init:** `.gitignore` archives created by `npm pack` +- bea10c7: **template/private-npm-package:** Include a half-decent README +- 1b960a8: **configure, init:** Make mentioned commands actually runnable +- 573ea6e: **configure:** Clean up ignore files during migration +- eac8ae5: **configure, init:** `.dockerignore` the `.git` folder. This should decrease build times. +- 63d9f01: **configure:** Add notice for smt migrations +- b6296ac: **cli:** Suppress dependency deprecation warnings +- fe3a1a2: **configure:** Delete `.npmignore` +- 56cc9ef: **template:** Drop duplicate team name prompt +- 2169513: **template/koa-rest-api:** Use Koala's error handler +- aa6e1e8: **configure, init:** Reduce unintended stripping of `_` filename prefix + ## 3.6.0 ### Minor Changes diff --git a/README.md b/README.md index 6342f159a..0514734f6 100644 --- a/README.md +++ b/README.md @@ -46,13 +46,13 @@ Related reading: To create a new project: ```shell -npx skuba@3.7.0-beta.6 init +npx skuba init ``` To bootstrap an existing project: ```shell -npx skuba@3.7.0-beta.6 configure +npx skuba configure ``` ## CLI reference diff --git a/package.json b/package.json index 63568755e..fa51bc0f4 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "engines": { "node": ">=12" }, - "version": "3.6.0", + "version": "3.7.0", "main": "lib-commonjs", "module": "lib-es2015", "typings": "lib-types/index.d.ts",