Merge pull request #16 from avalon-vanguard/develop
🔖 0.4.1 — the published README says the package is not on npm
This commit is contained in:
@@ -5,6 +5,20 @@ All notable changes to this project are documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [0.4.1] - 2026-08-20
|
||||||
|
|
||||||
|
No code changes. Every emitted file is byte-identical to 0.4.0 except the banner line of
|
||||||
|
`dist/cereale.min.js`, which carries the version string. This exists because the README
|
||||||
|
inside the 0.4.0 tarball is the one npmjs.com renders, and it said the package was not on
|
||||||
|
npm: *"`npm install cereale` does not resolve to this library — the name is unclaimed on
|
||||||
|
the registry."* True when it was written, nonsense on the package page of the thing it
|
||||||
|
describes.
|
||||||
|
|
||||||
|
0.4.0 was the first publish, so nothing could have carried the corrected text: the docs
|
||||||
|
could only be fixed after the registry proved the claim wrong. The install instructions,
|
||||||
|
the landing page panel, and the "what cereale is not" entry now say `npm install cereale`,
|
||||||
|
and the README carries an npm version badge.
|
||||||
|
|
||||||
## [0.4.0] - 2026-08-05
|
## [0.4.0] - 2026-08-05
|
||||||
|
|
||||||
### `cereale/min` — one file, no bundler
|
### `cereale/min` — one file, no bundler
|
||||||
|
|||||||
+2
-2
@@ -410,7 +410,7 @@ footer { border-top: 1px solid var(--border); padding-block: 2.5rem; color: var(
|
|||||||
|
|
||||||
<header class="nav">
|
<header class="nav">
|
||||||
<div class="wrap nav-inner">
|
<div class="wrap nav-inner">
|
||||||
<a class="brand" href="#top"><svg class="mark" width="10" height="18" viewBox="0 0 10 18" aria-hidden="true" focusable="false"><rect x="4" y="0" width="2" height="18" fill="currentColor" opacity=".3"/><rect x="0" y="2" width="10" height="2" fill="currentColor"/><rect x="0" y="6" width="10" height="2" fill="currentColor"/><rect x="0" y="10" width="10" height="2" fill="currentColor"/><rect x="0" y="14" width="10" height="2" fill="currentColor"/></svg>cereale <span class="badge" id="version-badge">v0.4.0</span></a>
|
<a class="brand" href="#top"><svg class="mark" width="10" height="18" viewBox="0 0 10 18" aria-hidden="true" focusable="false"><rect x="4" y="0" width="2" height="18" fill="currentColor" opacity=".3"/><rect x="0" y="2" width="10" height="2" fill="currentColor"/><rect x="0" y="6" width="10" height="2" fill="currentColor"/><rect x="0" y="10" width="10" height="2" fill="currentColor"/><rect x="0" y="14" width="10" height="2" fill="currentColor"/></svg>cereale <span class="badge" id="version-badge">v0.4.1</span></a>
|
||||||
<nav class="nav-links" aria-label="Primary">
|
<nav class="nav-links" aria-label="Primary">
|
||||||
<a class="nav-hide" href="#guarantee">Guarantee</a>
|
<a class="nav-hide" href="#guarantee">Guarantee</a>
|
||||||
<a class="nav-hide" href="#playground">Playground</a>
|
<a class="nav-hide" href="#playground">Playground</a>
|
||||||
@@ -992,7 +992,7 @@ export default defineConfig({
|
|||||||
</div>
|
</div>
|
||||||
<div class="note-item">
|
<div class="note-item">
|
||||||
<h3>It is still 0.x</h3>
|
<h3>It is still 0.x</h3>
|
||||||
<p><span class="js-version">0.4.0</span> is published, and under semver a 0.x minor bump
|
<p><span class="js-version">0.4.1</span> is published, and under semver a 0.x minor bump
|
||||||
is allowed to break you. Pin the version until 1.0; the
|
is allowed to break you. Pin the version until 1.0; the
|
||||||
<a href="https://github.com/avalon-vanguard/cereale/blob/main/CHANGELOG.md">changelog</a>
|
<a href="https://github.com/avalon-vanguard/cereale/blob/main/CHANGELOG.md">changelog</a>
|
||||||
says what moved and why.</p>
|
says what moved and why.</p>
|
||||||
|
|||||||
+1
-1
@@ -1,5 +1,5 @@
|
|||||||
// Generated by scripts/build-docs.mjs — do not edit.
|
// Generated by scripts/build-docs.mjs — do not edit.
|
||||||
window.CEREALE_META = {
|
window.CEREALE_META = {
|
||||||
"version": "0.4.0",
|
"version": "0.4.1",
|
||||||
"node": ">=20.0.0"
|
"node": ">=20.0.0"
|
||||||
};
|
};
|
||||||
|
|||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "cereale",
|
"name": "cereale",
|
||||||
"version": "0.3.0",
|
"version": "0.4.1",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "cereale",
|
"name": "cereale",
|
||||||
"version": "0.3.0",
|
"version": "0.4.1",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/standalone": "^8.0.4",
|
"@babel/standalone": "^8.0.4",
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "cereale",
|
"name": "cereale",
|
||||||
"version": "0.4.0",
|
"version": "0.4.1",
|
||||||
"description": "Strongly typed JSON mapping and validation for TypeScript classes \u2014 validated domain objects, not validated data. A zero-dependency replacement for class-validator + class-transformer, on TC39 standard decorators.",
|
"description": "Strongly typed JSON mapping and validation for TypeScript classes \u2014 validated domain objects, not validated data. A zero-dependency replacement for class-validator + class-transformer, on TC39 standard decorators.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/cjs/index.js",
|
"main": "./dist/cjs/index.js",
|
||||||
|
|||||||
@@ -49,6 +49,27 @@ await writeFile(
|
|||||||
`window.CEREALE_META = ${JSON.stringify({ version: pkg.version, node: pkg.engines.node }, null, 2)};\n`
|
`window.CEREALE_META = ${JSON.stringify({ version: pkg.version, node: pkg.engines.node }, null, 2)};\n`
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// 2b. The same version, stamped into the two spots in index.html that page.js later
|
||||||
|
// overwrites from meta.js. Those are the no-JavaScript fallbacks: correct in a browser,
|
||||||
|
// stale in a text reader or a scraper, and hand-bumped until now — they went stale on
|
||||||
|
// 0.4.0 and again on 0.4.1. Stamping them here means the docs-sync gate catches the
|
||||||
|
// drift instead of a reviewer. The regexes are asserted, so if the markup is renamed
|
||||||
|
// the build fails loudly rather than silently stamping nothing.
|
||||||
|
const indexPath = path.join(docs, 'index.html');
|
||||||
|
let index = await readFile(indexPath, 'utf8');
|
||||||
|
const stamps = [
|
||||||
|
[/(<span class="badge" id="version-badge">)v[\d.]+(<\/span>)/, `$1v${pkg.version}$2`],
|
||||||
|
[/(<span class="js-version">)[\d.]+(<\/span>)/g, `$1${pkg.version}$2`],
|
||||||
|
];
|
||||||
|
for (const [re, replacement] of stamps) {
|
||||||
|
if (!re.test(index)) {
|
||||||
|
console.error(`build-docs: nothing in docs/index.html matched ${re} — the version fallback markup moved.`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
index = index.replace(re, replacement);
|
||||||
|
}
|
||||||
|
await writeFile(indexPath, index);
|
||||||
|
|
||||||
// 3. The compiler errors the page quotes, produced by actually running the compiler. If a
|
// 3. The compiler errors the page quotes, produced by actually running the compiler. If a
|
||||||
// snippet the page calls a compile error ever compiles, this fails the build.
|
// snippet the page calls a compile error ever compiles, this fails the build.
|
||||||
const { byCase, problems } = await collectDiagnostics(root);
|
const { byCase, problems } = await collectDiagnostics(root);
|
||||||
|
|||||||
Reference in New Issue
Block a user