@nan0web/release 1.0.1 → 1.0.3

package/src/README.md.js

@@ -1,29 +1,26 @@
-import { describe, it, before, beforeEach } from "node:test"
-import assert from "node:assert/strict"
-import FS from "@nan0web/db-fs"
-import { NoConsole } from "@nan0web/log"
-import {
-	DatasetParser,
-	DocsParser,
-	runSpawn,
-} from "@nan0web/test"
-import ReleaseCLI from "./ReleaseCLI.js"
-import Release from "./Release.js"
-import ReleaseDocument from "./Release/Document.js"
-import Person from "./Release/Person.js"
+import { describe, it, before, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
+import { readFile } from 'node:fs/promises'
+import FS from '@nan0web/db-fs'
+import { NoConsole } from '@nan0web/log'
+import { DatasetParser, DocsParser, runSpawn } from '@nan0web/test'
+import ReleaseCLi from './ui/cli/ReleaseCLi.js'
+import Release from './Release.js'
+import ReleaseDocument from './Release/Document.js'
+import Person from './Release/Person.js'
 import {
 	ProjectManagement,
 	ReleaseManager,
 	TaskTestSuite,
-	ChangelogTaskManager
-} from "./architecture/ProjectManagementAsCode.js"
+	ChangelogTaskManager,
+} from './architecture/ProjectManagementAsCode.js'
 
 const fs = new FS()
 let pkg
 
 // Load package.json once before tests
 before(async () => {
-	const doc = await fs.loadDocument("package.json", {})
+	const doc = await fs.loadDocument('package.json', {})
 	pkg = doc || {}
 })
 
@@ -63,35 +60,35 @@ function testRender() {
 	 *
 	 * ## Installation
 	 */
-	it("How to install with pnpm?", () => {
+	it('How to install with pnpm?', () => {
 		/**
 		 * ```bash
 		 * pnpm add @nan0web/release
 		 * ```
 		 */
-		assert.equal(pkg.name, "@nan0web/release")
+		assert.equal(pkg.name, '@nan0web/release')
 	})
 	/**
 	 * @docs
 	 */
-	it("How to install with npm?", () => {
+	it('How to install with npm?', () => {
 		/**
 		 * ```bash
 		 * npm install @nan0web/release
 		 * ```
 		 */
-		assert.equal(pkg.name, "@nan0web/release")
+		assert.equal(pkg.name, '@nan0web/release')
 	})
 	/**
 	 * @docs
 	 */
-	it("How to install with yarn?", () => {
+	it('How to install with yarn?', () => {
 		/**
 		 * ```bash
 		 * yarn add @nan0web/release
 		 * ```
 		 */
-		assert.equal(pkg.name, "@nan0web/release")
+		assert.equal(pkg.name, '@nan0web/release')
 	})
 
 	/**
@@ -100,103 +97,103 @@ function testRender() {
 	 *
 	 * Start by initializing a new release:
 	 */
-	it("How to initialize a new release version?", () => {
+	it('How to initialize a new release version?', () => {
 		/**
 		 * ```bash
 		 * release init v1.0.0
 		 * ```
 		 */
-		const cli = new ReleaseCLI()
-		assert.ok(cli instanceof ReleaseCLI)
+		const cli = ReleaseCLi()
+		assert.ok(cli.logger)
 	})
 
 	/**
 	 * @docs
 	 * Show release details:
 	 */
-	it("How to show release information?", () => {
+	it('How to show release information?', () => {
 		/**
 		 * ```bash
 		 * release show [--full]
 		 * ```
 		 */
 		const release = new Release({
-			version: "v1.0.0",
-			createdAt: new Date("2025-08-20")
+			version: 'v1.0.0',
+			createdAt: new Date('2025-08-20'),
 		})
 		console.info(release.version) // v1.0.0
-		assert.strictEqual(console.output()[0][1], "v1.0.0")
+		assert.strictEqual(console.output()[0][1], 'v1.0.0')
 	})
 
 	/**
 	 * @docs
 	 * List all releases in the project:
 	 */
-	it("How to list all releases?", () => {
+	it('How to list all releases?', () => {
 		/**
 		 * ```bash
 		 * release list [--json]
 		 * ```
 		 */
-		const cli = new ReleaseCLI()
-		assert.ok(cli.releases)
+		const cli = ReleaseCLi()
+		assert.ok(cli.logger)
 	})
 
 	/**
 	 * @docs
 	 * Add a chat message to the current release:
 	 */
-	it("How to write a release chat message?", () => {
+	it('How to write a release chat message?', () => {
 		/**
 		 * ```bash
 		 * release chat write --user alice "Issue with the build pipeline"
 		 * ```
 		 */
-		const cli = new ReleaseCLI()
-		assert.ok(cli instanceof ReleaseCLI)
+		const cli = ReleaseCLi()
+		assert.ok(cli.logger)
 	})
 
 	/**
 	 * @docs
 	 * Host a static server for viewing releases:
 	 */
-	it("How to host release UI?", () => {
+	it('How to host release UI?', () => {
 		/**
 		 * ```bash
 		 * release host [--webui] [--port 3000]
 		 * ```
 		 */
-		const cli = new ReleaseCLI()
-		assert.ok(cli instanceof ReleaseCLI)
+		const cli = ReleaseCLi()
+		assert.ok(cli.logger)
 	})
 
 	/**
 	 * @docs
 	 * Serve all release files for local inspection:
 	 */
-	it("How to serve release static assets?", () => {
+	it('How to serve release static assets?', () => {
 		/**
 		 * ```bash
 		 * release serve [--port 8080]
 		 * ```
 		 */
-		const cli = new ReleaseCLI()
-		assert.ok(cli instanceof ReleaseCLI)
+		const cli = ReleaseCLi()
+		assert.ok(cli.logger)
 	})
 
 	/**
 	 * @docs
 	 * Validate release tasks and integrity:
 	 */
-	it("How to validate release tasks?", () => {
+	it('How to validate release tasks?', () => {
 		/**
 		 * ```bash
 		 * release validate [--ignore-fail]
 		 * ```
 		 */
 		const release = new Release({
-			version: "v1.0.0",
-			createdAt: new Date("2025-08-20")
+			version: 'v1.0.0',
+			createdAt: new Date('2025-08-20'),
 		})
 		assert.ok(release instanceof Release)
 	})
@@ -205,14 +202,14 @@ function testRender() {
 	 * @docs
 	 * Seal the release with retro reflection:
 	 */
-	it("How to seal a release?", () => {
+	it('How to seal a release?', () => {
 		/**
 		 * ```bash
 		 * release seal [--message "All core APIs are stable and tested"]
 		 * ```
 		 */
-		const cli = new ReleaseCLI()
-		assert.ok(cli instanceof ReleaseCLI)
+		const cli = ReleaseCLi()
+		assert.ok(cli.logger)
 	})
 
 	/**
@@ -228,16 +225,16 @@ function testRender() {
 	 *
 	 * Each property is typed and validated automatically via JSDoc and runtime parsing.
 	 */
-	it("How to instantiate a Release?", () => {
+	it('How to instantiate a Release?', () => {
 		//import { Release } from '@nan0web/release'
 		const release = new Release({
-			version: "v1.0.0",
-			createdAt: "2025-08-20T10:00:00Z"
+			version: 'v1.0.0',
+			createdAt: '2025-08-20T10:00:00Z',
 		})
 		console.info(release.version) // ← v1.0.0
 		console.info(release.createdAt instanceof Date) // ← true
 
-		assert.strictEqual(console.output()[0][1], "v1.0.0")
+		assert.strictEqual(console.output()[0][1], 'v1.0.0')
 		assert.strictEqual(console.output()[1][1], true)
 	})
 
@@ -250,7 +247,7 @@ function testRender() {
 	 * - Extraction of sections and tasks
 	 * - Team and role parsing from markdown frontmatter or code
 	 */
-	it("How to parse release notes markdown into structured data?", () => {
+	it('How to parse release notes markdown into structured data?', () => {
 		//import { ReleaseDocument } from '@nan0web/release'
 		const md = `# v1.0.0 - 2025-08-20
 
@@ -266,7 +263,7 @@ Release milestone includes UI polish and core API stabilization.
 		console.info(doc.date instanceof Date) // ← true
 		console.info(doc.document.children instanceof Array) // ← true
 
-		assert.strictEqual(console.output()[0][1], "v1.0.0")
+		assert.strictEqual(console.output()[0][1], 'v1.0.0')
 		assert.strictEqual(console.output()[1][1], true)
 		assert.strictEqual(console.output()[2][1], true)
 	})
@@ -280,17 +277,17 @@ Release milestone includes UI polish and core API stabilization.
 	 * - `gender`: HumanGender
 	 * - `contacts`: array of HumanContact
 	 */
-	it("How to create a Person with typed properties?", () => {
+	it('How to create a Person with typed properties?', () => {
 		//import { Person } from '@nan0web/release'
 		const person = new Person({
-			name: ["Alice", "Developer"],
-			gender: "female",
-			contacts: ["mailto:alice@example.com"]
+			name: ['Alice', 'Developer'],
+			gender: 'female',
+			contacts: ['mailto:alice@example.com'],
 		})
 		console.info(person.name.firstName) // ← Alice
 		console.info(person.contacts.length >= 0) // ← true
 
-		assert.strictEqual(console.output()[0][1], "Alice")
+		assert.strictEqual(console.output()[0][1], 'Alice')
 		assert.strictEqual(console.output()[1][1], true)
 	})
 
@@ -305,23 +302,23 @@ Release milestone includes UI polish and core API stabilization.
 	 * Tasks are registered as `taskId` → `testFilePath` in `ProjectManagement`.
 	 * Their status is derived by running `node:test` suites.
 	 */
-	it("How to register and validate tasks as tests?", async () => {
+	it('How to register and validate tasks as tests?', async () => {
 		//import { ProjectManagement } from '@nan0web/release'
 		const pm = new ProjectManagement()
-		pm.registerTask("task-1", "./tests/task1.test.js")
-		pm.registerTask("task-2", "./tests/task2.test.js")
+		pm.registerTask('task-1', './tests/task1.test.js')
+		pm.registerTask('task-2', './tests/task2.test.js')
 
 		const mockResults = {
-			passed: ["task-1"],
+			passed: ['task-1'],
 			failed: [],
-			pending: ["task-2"]
+			pending: ['task-2'],
 		}
 
 		pm.validateProjectState = async () => mockResults
 		const results = await pm.validateProjectState()
 
-		console.info(results.passed.includes("task-1")) // ← true
-		console.info(results.pending.includes("task-2")) // ← true
+		console.info(results.passed.includes('task-1')) // ← true
+		console.info(results.pending.includes('task-2')) // ← true
 
 		assert.strictEqual(console.output()[0][1], true)
 		assert.strictEqual(console.output()[1][1], true)
@@ -337,19 +334,19 @@ Release milestone includes UI polish and core API stabilization.
 	 * - Version is correctly incremented
 	 * - Git tag is applied if all validations succeed
 	 */
-	it("How to execute a release after validation?", async () => {
+	it('How to execute a release after validation?', async () => {
 		//import { ReleaseManager, ProjectManagement } from '@nan0web/release'
 		const pm = new ProjectManagement()
 		const rm = new ReleaseManager(pm)
 
-		rm.calculateVersion = () => "v1.0.1"
+		rm.calculateVersion = () => 'v1.0.1'
 		rm.publish = async () => true
 
-		const result = await rm.executeRelease("patch")
+		const result = await rm.executeRelease('patch')
 		console.info(result.version) // ← v1.0.1
 		console.info(result.published) // ← true
 
-		assert.strictEqual(console.output()[0][1], "v1.0.1")
+		assert.strictEqual(console.output()[0][1], 'v1.0.1')
 		assert.strictEqual(console.output()[1][1], true)
 	})
 
@@ -362,7 +359,7 @@ Release milestone includes UI polish and core API stabilization.
 	 * - Generate corresponding test files
 	 * - Automate task progression in CI
 	 */
-	it("How to parse changelog and extract tasks?", () => {
+	it('How to parse changelog and extract tasks?', () => {
 		//import { ChangelogTaskManager } from '@nan0web/release'
 		const ctm = new ChangelogTaskManager()
 		const changelog = `# Changelog
@@ -384,9 +381,9 @@ Release milestone includes UI polish and core API stabilization.
 	 * @docs
 	 * ## Java•Script Features
 	 */
-	it("Uses JSDoc and .d.ts files for autocompletion", () => {
+	it('Uses JSDoc and .d.ts files for autocompletion', () => {
 		assert.ok(pkg.types)
-		assert.ok(pkg.types.includes(".d.ts"))
+		assert.ok(pkg.types.includes('.d.ts'))
 	})
 
 	/**
@@ -395,7 +392,7 @@ Release milestone includes UI polish and core API stabilization.
 	 *
 	 * Try the package in the terminal:
 	 */
-	it("How to run playground demo?", async () => {
+	it('How to run playground demo?', async () => {
 		/**
 		 * ```bash
 		 * git clone https://github.com/nan0web/release.git
@@ -405,9 +402,9 @@ Release milestone includes UI polish and core API stabilization.
 		 * ```
 		 */
 		assert.ok(pkg.scripts?.playground)
-		const response = await runSpawn("git", ["remote", "get-url", "origin"])
+		const response = await runSpawn('git', ['remote', 'get-url', 'origin'])
 		assert.ok(response.code === 0)
-		assert.ok(response.text.trim().endsWith(":nan0web/release.git"))
+		assert.ok(response.text.trim().endsWith(':nan0web/release.git'))
 	})
 
 	/**
@@ -416,7 +413,7 @@ Release milestone includes UI polish and core API stabilization.
 	 *
 	 * To verify the project is ready, run:
 	 */
-	it("How to check project status before publishing?", async () => {
+	it('How to check project status before publishing?', async () => {
 		/**
 		 * ```bash
 		 * npm test
@@ -425,44 +422,44 @@ Release milestone includes UI polish and core API stabilization.
 		 * ```
 		 */
 		assert.ok(pkg.scripts?.test)
-		assert.ok(pkg.scripts?.["test:coverage"])
-		assert.ok(pkg.scripts?.["test:status"])
+		assert.ok(pkg.scripts?.['test:coverage'])
+		assert.ok(pkg.scripts?.['test:status'])
 	})
 
 	/**
 	 * @docs
 	 * ## Contributing
 	 */
-	it("How to contribute? - [check here](./CONTRIBUTING.md)", async () => {
-		assert.equal(pkg.scripts?.precommit, "npm test")
-		assert.equal(pkg.scripts?.prepush, "npm test")
-		assert.equal(pkg.scripts?.prepare, "husky")
+	it('How to contribute? - [check here](./CONTRIBUTING.md)', async () => {
+		assert.equal(pkg.scripts?.precommit, 'npm test')
+		assert.equal(pkg.scripts?.prepush, 'npm test')
+		assert.equal(pkg.scripts?.prepare, 'husky')
 	})
 
 	/**
 	 * @docs
 	 * ## License
 	 */
-	it("How to license ISC? - [check here](./LICENSE)", async () => {
+	it('How to license ISC? - [check here](./LICENSE)', async () => {
 		/** @docs */
-		const text = await fs.loadDocument("LICENSE")
-		assert.ok(String(text).includes("ISC"))
+		const text = await fs.loadDocument('LICENSE')
+		assert.ok(String(text).includes('ISC'))
 	})
 }
 
-describe("README.md testing", testRender)
+describe('README.md testing', testRender)
 
-describe("Rendering README.md", async () => {
-	let text = ""
-	const format = new Intl.NumberFormat("en-US").format
+describe('Rendering README.md', async () => {
+	let text = ''
+	const format = new Intl.NumberFormat('en-US').format
 	const parser = new DocsParser()
 	text = String(parser.decode(testRender))
-	await fs.saveDocument("README.md", text)
+	await fs.saveDocument('README.md', text)
 	const dataset = DatasetParser.parse(text, pkg.name)
-	await fs.saveDocument(".datasets/README.dataset.jsonl", dataset)
+	await fs.saveDocument('.datasets/README.dataset.jsonl', dataset)
 
 	it(`document is rendered [${format(Buffer.byteLength(text))}b]`, async () => {
-		const text = await fs.loadDocument("README.md")
-		assert.ok(text.includes("## License"))
+		const text = await readFile('README.md', 'utf8')
+		assert.ok(text.includes('## License'))
 	})
 })

package/src/Release/Document.js

@@ -1,5 +1,5 @@
-import Markdown, { MDElement, MDHeading1, MDHeading2, MDHeading3 } from "@nan0web/markdown"
-import Person from "./Person.js"
+import Markdown, { MDElement, MDHeading1, MDHeading2, MDHeading3 } from '@nan0web/markdown'
+import Person from './Person.js'
 
 class ReleaseDocument extends Markdown {
 	/** @type {Person[]} */
@@ -20,15 +20,10 @@ class ReleaseDocument extends Markdown {
 	 */
 	constructor(options = {}) {
 		super()
-		const {
-			team = [],
-			roles = new Map(),
-			version = "",
-			date
-		} = options
+		const { team = [], roles = new Map(), version = '', date } = options
 		this.version = String(version)
 		this.date = date ? new Date(date) : undefined
-		this.team = team.map(t => Person.from(t))
+		this.team = team.map((t) => Person.from(t))
 		this.roles = new Map(roles)
 	}
 
@@ -43,13 +38,13 @@ class ReleaseDocument extends Markdown {
 
 		const h1s = this.document.filter((el) => el instanceof MDHeading1)
 		if (h1s.length !== 1) {
-			throw new TypeError("Release document must have exactly one H1 heading with version and date")
+			throw new TypeError('Release document must have exactly one H1 heading with version and date')
 		}
 
-		const h1Content = h1s[0].content ?? ""
-		const [versionPart, ...dateParts] = h1Content.split(" - ")
+		const h1Content = h1s[0].content ?? ''
+		const [versionPart, ...dateParts] = h1Content.split(' - ')
 		this.version = versionPart.trim()
-		this.date = new Date(dateParts.join(" - ").trim())
+		this.date = new Date(dateParts.join(' - ').trim())
 
 		const sections = []
 		/** @type {{title: string, tasks: Array} | null} */
@@ -58,11 +53,10 @@ class ReleaseDocument extends Markdown {
 			if (el instanceof MDHeading2) {
 				currentSection = {
 					title: el.content.trim(),
-					tasks: []
+					tasks: [],
 				}
 				sections.push(currentSection)
-			}
-			else if (el instanceof MDHeading3 && currentSection) {
+			} else if (el instanceof MDHeading3 && currentSection) {
 				const content = el.content.trim()
 				const statusMatch = content.match(/^(\w+)\s*(.+)$/)
 				const slugMatch = content.match(/\[([^\]]+)\]$/)
@@ -84,7 +78,7 @@ class ReleaseDocument extends Markdown {
 				currentSection.tasks.push({
 					content: taskContent,
 					status: status,
-					slug: slug
+					slug: slug,
 				})
 			}
 		}
@@ -98,7 +92,7 @@ class ReleaseDocument extends Markdown {
 	 */
 	static from(input) {
 		if (input instanceof ReleaseDocument) return input
-		if (typeof input === "string") {
+		if (typeof input === 'string') {
 			const doc = new ReleaseDocument()
 			doc.parse(input)
 			return doc
@@ -107,4 +101,4 @@ class ReleaseDocument extends Markdown {
 	}
 }
 
-export default ReleaseDocument
+export default ReleaseDocument