Skip to content

docs: fix stale bin/cli.js references in README#74

Open
nmccready-tars wants to merge 123 commits intomonken:masterfrom
brickhouse-tech:chore/fix-readme-cli-references
Open

docs: fix stale bin/cli.js references in README#74
nmccready-tars wants to merge 123 commits intomonken:masterfrom
brickhouse-tech:chore/fix-readme-cli-references

Conversation

@nmccready-tars
Copy link

Fixes 4 stale references to ./bin/cli.js in README.md — the bin entry points to dist/cli.js but users should use the cfn-include command directly.

Refs #84

nmccready and others added 30 commits November 5, 2024 20:44
…bled

fix: fail Fn::Eval, Fn::IfEval if opts.doEval is falsy
Bumps [sort-package-json](https://github.com/keithamus/sort-package-json) from 2.10.1 to 3.2.1.
- [Release notes](https://github.com/keithamus/sort-package-json/releases)
- [Commits](keithamus/sort-package-json@v2.10.1...v3.2.1)

---
updated-dependencies:
- dependency-name: sort-package-json
  dependency-version: 3.2.1
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 9.1.0 to 10.1.5.
- [Release notes](https://github.com/prettier/eslint-config-prettier/releases)
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/eslint-config-prettier@v9.1.0...v10.1.5)

---
updated-dependencies:
- dependency-name: eslint-config-prettier
  dependency-version: 10.1.5
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
…ckage-json-3.2.1

chore(deps-dev): bump sort-package-json from 2.10.1 to 3.2.1
…config-prettier-10.1.5

chore(deps-dev): bump eslint-config-prettier from 9.1.0 to 10.1.5
…11a52fe

fix(deps): bump the all group across 1 directory with 12 updates
Bumps the all group with 5 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [@znemz/cft-utils](https://github.com/nmccready/cft-utils) | `0.1.19` | `0.1.22` |
| [glob](https://github.com/isaacs/node-glob) | `11.1.0` | `12.0.0` |
| [js-yaml](https://github.com/nodeca/js-yaml) | `3.14.2` | `4.1.1` |
| [yargs](https://github.com/yargs/yargs) | `17.7.2` | `18.0.0` |
| [mocha](https://github.com/mochajs/mocha) | `11.7.2` | `11.7.5` |



Updates `@znemz/cft-utils` from 0.1.19 to 0.1.22
- [Release notes](https://github.com/nmccready/cft-utils/releases)
- [Changelog](https://github.com/nmccready/cft-utils/blob/main/CHANGELOG.md)
- [Commits](brickhouse-tech/cft-utils@v0.1.19...v0.1.22)

Updates `glob` from 11.1.0 to 12.0.0
- [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md)
- [Commits](isaacs/node-glob@v11.1.0...v12.0.0)

Updates `js-yaml` from 3.14.2 to 4.1.1
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](nodeca/js-yaml@3.14.2...4.1.1)

Updates `yargs` from 17.7.2 to 18.0.0
- [Release notes](https://github.com/yargs/yargs/releases)
- [Changelog](https://github.com/yargs/yargs/blob/main/CHANGELOG.md)
- [Commits](yargs/yargs@v17.7.2...v18.0.0)

Updates `mocha` from 11.7.2 to 11.7.5
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/v11.7.5/CHANGELOG.md)
- [Commits](mochajs/mocha@v11.7.2...v11.7.5)

---
updated-dependencies:
- dependency-name: "@znemz/cft-utils"
  dependency-version: 0.1.22
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: glob
  dependency-version: 12.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: js-yaml
  dependency-version: 4.1.1
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: yargs
  dependency-version: 18.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: mocha
  dependency-version: 11.7.5
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>
…4b45b08

fix(deps): bump the all group across 1 directory with 5 updates
creadbot_github and others added 30 commits February 8, 2026 19:57
Phase 2B: Dependency cleanup for ESM migration.

Changes:
- Remove bluebird → native Promise + lib/promise-utils.js
  - promiseProps: replaces Promise.props
  - promiseTry: replaces Promise.try
  - promiseMap: replaces Promise.map
- Remove path-parse → use native path.parse()
- Update lib/promise.js to use native promises

Dependencies removed:
- bluebird (^3.7.2)
- path-parse (~1.0.7)

Benchmark results improved slightly after removing bluebird overhead.
All 194 tests passing.
…eanup

refactor: Phase 2B - Remove bluebird and path-parse dependencies
BREAKING CHANGE: Package now uses ESM instead of CommonJS

- Add "type": "module" to package.json
- Add "exports" field for explicit module resolution
- Convert all source files (index.js, lib/*.js) to ESM
- Convert all test files (t/*.js, t/tests/*.js) to ESM
- Replace jsonminify with inline implementation
- Replace lodash require with default import

All 194 tests passing.
- commitlint.config.js → commitlint.config.cjs
- jest.config.js → jest.config.cjs
- Create src/ directory structure (lib/, types/, lib/include/)
- Add comprehensive type definitions in src/types/
- Convert 13 lib files to TypeScript
- Add main src/index.ts with all Fn:: handlers
- Configure TypeScript (strict mode, ES2022, NodeNext)
- Benchmark results: Map-1000=24ms, Complex=417μs

BREAKING CHANGE: Package is now ESM-only. CommonJS require() no longer works.
Use dynamic import() or migrate to ESM.
BREAKING CHANGE: Package is now ESM-only. CommonJS require() no longer works.

- Fix version bump (should have been 3.0.0 due to ESM breaking change)
- Update CHANGELOG.md with Phase 1-3 changes
- Add .versionrc.json for commit-and-tag-version config
- Add fetch-depth: 0 for full git history
- Check all commits (not just first-parent) for feat!:/BREAKING CHANGE
- Force major version bump when breaking changes detected
fix!: release 3.0.0 - ESM breaking change
Bumps the all group with 7 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [@aws-sdk/client-cloudformation](https://github.com/aws/aws-sdk-js-v3/tree/HEAD/clients/client-cloudformation) | `3.980.0` | `3.981.0` |
| [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3/tree/HEAD/clients/client-s3) | `3.980.0` | `3.981.0` |
| [@znemz/cft-utils](https://github.com/brickhouse-tech/cft-utils) | `0.1.33` | `0.1.34` |
| [glob](https://github.com/isaacs/node-glob) | `13.0.0` | `13.0.1` |
| [@commitlint/cli](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/cli) | `20.4.0` | `20.4.1` |
| [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/config-conventional) | `20.4.0` | `20.4.1` |
| [commitlint](https://github.com/conventional-changelog/commitlint/tree/HEAD/@alias/commitlint) | `20.4.0` | `20.4.1` |



Updates `@aws-sdk/client-cloudformation` from 3.980.0 to 3.981.0
- [Release notes](https://github.com/aws/aws-sdk-js-v3/releases)
- [Changelog](https://github.com/aws/aws-sdk-js-v3/blob/main/clients/client-cloudformation/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js-v3/commits/v3.981.0/clients/client-cloudformation)

Updates `@aws-sdk/client-s3` from 3.980.0 to 3.981.0
- [Release notes](https://github.com/aws/aws-sdk-js-v3/releases)
- [Changelog](https://github.com/aws/aws-sdk-js-v3/blob/main/clients/client-s3/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js-v3/commits/v3.981.0/clients/client-s3)

Updates `@znemz/cft-utils` from 0.1.33 to 0.1.34
- [Release notes](https://github.com/brickhouse-tech/cft-utils/releases)
- [Changelog](https://github.com/brickhouse-tech/cft-utils/blob/main/CHANGELOG.md)
- [Commits](brickhouse-tech/cft-utils@v0.1.33...v0.1.34)

Updates `glob` from 13.0.0 to 13.0.1
- [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md)
- [Commits](isaacs/node-glob@v13.0.0...v13.0.1)

Updates `@commitlint/cli` from 20.4.0 to 20.4.1
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/cli/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v20.4.1/@commitlint/cli)

Updates `@commitlint/config-conventional` from 20.4.0 to 20.4.1
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/config-conventional/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v20.4.1/@commitlint/config-conventional)

Updates `commitlint` from 20.4.0 to 20.4.1
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@alias/commitlint/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v20.4.1/@alias/commitlint)

---
updated-dependencies:
- dependency-name: "@aws-sdk/client-cloudformation"
  dependency-version: 3.981.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: "@aws-sdk/client-s3"
  dependency-version: 3.981.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: "@znemz/cft-utils"
  dependency-version: 0.1.34
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: glob
  dependency-version: 13.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: "@commitlint/cli"
  dependency-version: 20.4.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: "@commitlint/config-conventional"
  dependency-version: 20.4.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: commitlint
  dependency-version: 20.4.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>
…ll-61151396f8

fix(deps): bump the all group across 1 directory with 7 updates
- Add Vitest test framework with TypeScript support
- Create test/ directory with TypeScript test files:
  - test/include.test.ts - Main include tests (182 tests)
  - test/cli.test.ts - CLI tests (11 tests)
  - test/replaceEnv.test.ts - Environment variable tests (4 tests)
  - test/helpers.ts - Test utilities and fixtures loader
  - test/types.ts - TypeScript type definitions for tests
- Add vitest.config.ts with coverage support
- Remove Mocha and eslint-plugin-mocha dependencies
- Update package.json scripts:
  - test: runs vitest
  - test:watch: runs vitest in watch mode
  - test:coverage: runs vitest with coverage
- Keep legacy t/tests/ fixtures (JSON, YAML, JS) for test data

Performance: ~2.1s total test time (197 tests)
…cript-tests

feat: migrate tests to Vitest + TypeScript (Phase 3b)
Delete all legacy JavaScript files that were superseded by the TypeScript
rewrite in Phase 2:

- Remove JS test runners: t/cli.js, t/include.js, t/replaceEnv.js,
  t/unit.js, t/tests/extendEnv.js
- Remove legacy JS source: index.js, lib/*.js, lib/include/*.js
- Remove bin/cli.js shim (package.json bin already points to dist/cli.js)
- Update test/cli.test.ts to reference dist/cli.js instead of bin/cli.js
- Update benchmarks/benchmark-runner.js to import from dist/

All test fixture data in t/tests/, t/includes/, t/fixtures/, and
t/regression-fixtures/ is preserved (used by new TS tests).

197 tests pass.

Closes #80, closes #81, closes #82, closes #83
chore: Phase 3 cleanup — remove legacy JS files
Bumps the all group with 7 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [@aws-sdk/client-cloudformation](https://github.com/aws/aws-sdk-js-v3/tree/HEAD/clients/client-cloudformation) | `3.980.0` | `3.985.0` |
| [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3/tree/HEAD/clients/client-s3) | `3.980.0` | `3.985.0` |
| [glob](https://github.com/isaacs/node-glob) | `13.0.0` | `13.0.1` |
| [@commitlint/cli](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/cli) | `20.4.0` | `20.4.1` |
| [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/config-conventional) | `20.4.0` | `20.4.1` |
| [commitlint](https://github.com/conventional-changelog/commitlint/tree/HEAD/@alias/commitlint) | `20.4.0` | `20.4.1` |
| [eslint](https://github.com/eslint/eslint) | `9.39.2` | `10.0.0` |



Updates `@aws-sdk/client-cloudformation` from 3.980.0 to 3.985.0
- [Release notes](https://github.com/aws/aws-sdk-js-v3/releases)
- [Changelog](https://github.com/aws/aws-sdk-js-v3/blob/main/clients/client-cloudformation/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js-v3/commits/v3.985.0/clients/client-cloudformation)

Updates `@aws-sdk/client-s3` from 3.980.0 to 3.985.0
- [Release notes](https://github.com/aws/aws-sdk-js-v3/releases)
- [Changelog](https://github.com/aws/aws-sdk-js-v3/blob/main/clients/client-s3/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js-v3/commits/v3.985.0/clients/client-s3)

Updates `glob` from 13.0.0 to 13.0.1
- [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md)
- [Commits](isaacs/node-glob@v13.0.0...v13.0.1)

Updates `@commitlint/cli` from 20.4.0 to 20.4.1
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/cli/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v20.4.1/@commitlint/cli)

Updates `@commitlint/config-conventional` from 20.4.0 to 20.4.1
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/config-conventional/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v20.4.1/@commitlint/config-conventional)

Updates `commitlint` from 20.4.0 to 20.4.1
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@alias/commitlint/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v20.4.1/@alias/commitlint)

Updates `eslint` from 9.39.2 to 10.0.0
- [Release notes](https://github.com/eslint/eslint/releases)
- [Commits](eslint/eslint@v9.39.2...v10.0.0)

---
updated-dependencies:
- dependency-name: "@aws-sdk/client-cloudformation"
  dependency-version: 3.985.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: "@aws-sdk/client-s3"
  dependency-version: 3.985.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: glob
  dependency-version: 13.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: "@commitlint/cli"
  dependency-version: 20.4.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: "@commitlint/config-conventional"
  dependency-version: 20.4.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: commitlint
  dependency-version: 20.4.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: eslint
  dependency-version: 10.0.0
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>
…ll-130ed326fa

fix(deps): bump the all group across 1 directory with 7 updates
All references to ./bin/cli.js in README.md now use the npm bin
command 'cfn-include' which is the correct way to invoke the CLI.

Refs #84
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants