Skip to content

docs(readme): remove dead ideal-postcodes.dev link - #491

Merged
cblanc merged 7 commits into
masterfrom
devdomain
Sep 17, 2026
Merged

cblanc merged 7 commits into
masterfrom
devdomain

Conversation

@cblanc

@cblanc cblanc commented Sep 17, 2026 •

Copy link
Copy Markdown
Member

Summary

  • postcodejs.ideal-postcodes.dev (the retired TypeDoc site) is NXDOMAIN. Remove the API Documentation link; the README already documents every method
  • CHANGELOG.md still mentions the domain once. It is generated history, left alone

CI and toolchain

  • CI failed in "Set up job" because actions/cache@v1 is retired and GitHub fails any job that references it. All workflows now use actions/checkout@v7 and actions/setup-node@v7 (with its built-in npm cache, replacing actions/cache), and install with npm ci
  • CI matrix is Node 22.x and 24.x (was 10.x, 12.x, 14.x). Release runs on Node 24.x
  • release.yml checks out with fetch-depth: 0 and persist-credentials: false so semantic-release can see tags and push with GH_TOKEN
  • CodeQL moved to github/codeql-action@v4 with the javascript-typescript extractor
  • Coverage upload moved from the deprecated codecov npm package to codecov/codecov-action@v7
  • devDependencies updated and pinned exact: typescript 6.0.3, ts-node 10.9.2, mocha 12.0.1, chai 6.2.2, nyc 18.0.0, eslint 10.10.0 with typescript-eslint 8.70.0 (flat config), prettier 3.9.7, typedoc 0.28.20, semantic-release 25.0.9 with @semantic-release/changelog 7.0.0 and @semantic-release/git 11.0.1, axios 1.20.0, @types/node 22.20.3
  • Removed unused or dead devDependencies: tslint, @cablanchard/tslint, csv-parse, codecov, @ideal-postcodes/doc-assets, @cablanchard/eslint-config, @cablanchard/semantic-release (rules and release config inlined)
  • No runtime dependencies, engines, entry points or public API changed. The build still targets ES5 with the same dist/ and esm/ layout; emitted JavaScript differs only in compiler idiom. npm audit reports 0 vulnerabilities

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

The documentation and demo sites on ideal-postcodes.dev no longer resolve.
Linting runs through eslint and nothing imports csv-parse. npm also rewrites the lockfile to lockfileVersion 3 and drops the empty dependencies object.
TypeScript 6.0.3 is the newest release that can still emit the ES5 target this package ships; TypeScript 7 removes it. ignoreDeprecations keeps the target, rootDir keeps dist/ and esm/ flat, and types restores the node and mocha globals that TypeScript 6 no longer auto-includes. Emitted JavaScript differs from 4.2 only in compiler idiom: (0, exports.fn)() calls and "".concat() for template literals.

typedoc 0.28 cannot load the legacy @ideal-postcodes/doc-assets theme or the disableOutputCheck option, so both are dropped.
ESLint 10 no longer reads .eslintrc and @cablanchard/eslint-config only ships the legacy format, so its rules are inlined in eslint.config.js on typescript-eslint 8. ban-types was split upstream into no-empty-object-type, no-unsafe-function-type and no-wrapper-object-types; interface-name-prefix no longer exists.

Prettier moves to 3.x with trailingComma set to es5, which matches the existing formatting.
@cablanchard/semantic-release pins plugin majors that predate semantic-release 25, so the same plugin set is declared directly in package.json at current versions. tagFormat, the release commit message and the committed assets are unchanged. The changelog and version bump now land in one release commit instead of two.
The codecov npm uploader is deprecated and no longer accepted by Codecov. The coverage script now only writes coverage.lcov and codecov/codecov-action uploads it. Also refreshes locked transitive dependencies so npm audit reports no vulnerabilities.
Together with the ci.yml changes in the previous commit this moves every workflow off the retired actions/cache@v1, checkout@v1 and setup-node@v1 (GitHub now fails any job that references actions/cache v1 or v2) and off Node 10, 12 and 14. CI runs on Node 22 and 24, release on Node 24, which semantic-release 25 requires. npm caching moves to setup-node and installs use npm ci.

checkout v2 and later fetch a shallow clone and persist the workflow token, so release.yml sets fetch-depth 0 for semantic-release tag discovery and persist-credentials false so the release commit is pushed with GH_TOKEN as before.

CodeQL moves to v4 with the javascript-typescript extractor. The HEAD^2 checkout and autobuild steps are no longer needed.
@cblanc
cblanc merged commit 84c88a5 into master Sep 17, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant