@zenfs/devel 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,125 @@
1
+ import { parseSubject } from './commits.js';
2
+ import { compareVersions } from './versions.js';
3
+ export class PR {
4
+ number;
5
+ title = '';
6
+ subsystems = [];
7
+ author = '';
8
+ semver = 'unreleased';
9
+ revert = false;
10
+ /** Commits on the tracked ref, oldest first */
11
+ commits = [];
12
+ /** Every release that lists the PR, ascending */
13
+ releases = [];
14
+ /** Affected APIs, by ID */
15
+ apis = { added: [], removed: [], changed: [] };
16
+ constructor(number) {
17
+ this.number = number;
18
+ }
19
+ get url() {
20
+ return `https://github.com/nodejs/node/pull/${this.number}`;
21
+ }
22
+ /** Key for marks */
23
+ get key() {
24
+ return '#' + this.number;
25
+ }
26
+ /** Earliest version in each release line, ascending */
27
+ get versions() {
28
+ const earliest = new Map();
29
+ for (const release of this.releases)
30
+ if (!earliest.has(release.line))
31
+ earliest.set(release.line, release.version);
32
+ return [...earliest.values()];
33
+ }
34
+ /** Top-level directories touched */
35
+ get areas() {
36
+ return [...new Set(this.commits.flatMap(commit => commit.files.map(file => file.split('/')[0])))].sort();
37
+ }
38
+ /** Heuristic labels derived from the title and touched areas */
39
+ get tags() {
40
+ const tags = [];
41
+ const title = this.title.toLowerCase();
42
+ const { areas } = this;
43
+ if (this.revert)
44
+ tags.push('revert');
45
+ if (!this.commits.length)
46
+ tags.push('backport');
47
+ if (areas.length) {
48
+ if (!areas.includes('lib'))
49
+ tags.push(areas.includes('src') ? 'native' : areas.every(area => area == 'doc') ? 'docs' : 'internal');
50
+ if (areas.every(area => area == 'test' || area == 'doc'))
51
+ tags.push('test');
52
+ }
53
+ if (/\bwin(dows|32)?\b/.test(title) || this.subsystems.includes('win'))
54
+ tags.push('windows');
55
+ if (/\b(perf|performance|faster|optimi[sz]e|speed up|allocations?)\b/.test(title))
56
+ tags.push('perf');
57
+ if (/\b(experimental|stabilize|stable)\b/.test(title))
58
+ tags.push('stability');
59
+ if (/\b(deprecat|eol|end-of-life)/.test(title))
60
+ tags.push('deprecation');
61
+ return tags;
62
+ }
63
+ /** ISO date the PR landed on the tracked ref, or of its first release */
64
+ get date() {
65
+ return this.commits[0]?.date ?? this.releases[0]?.date ?? '';
66
+ }
67
+ /**
68
+ * Adds a commit in chronological order, along with the APIs it added or removed.
69
+ */
70
+ addCommit(commit, history) {
71
+ this.commits.push(commit);
72
+ const subject = parseSubject(commit.subject);
73
+ if (!this.title && subject) {
74
+ this.title = subject.title;
75
+ this.subsystems = subject.subsystems;
76
+ this.revert = subject.revert;
77
+ this.author = commit.author;
78
+ }
79
+ for (const id of history?.added ?? [])
80
+ toggle(this.apis.added, this.apis.removed, id);
81
+ for (const id of history?.removed ?? [])
82
+ toggle(this.apis.removed, this.apis.added, id);
83
+ }
84
+ addRelease(entry) {
85
+ if (!this.releases.some(release => release.version == entry.release.version)) {
86
+ this.releases.push(entry.release);
87
+ this.releases.sort((left, right) => compareVersions(left.version, right.version));
88
+ }
89
+ if (this.semver == 'unreleased' || entry.semver == 'major' || (entry.semver == 'minor' && this.semver == 'patch'))
90
+ this.semver = entry.semver;
91
+ if (this.title)
92
+ return;
93
+ this.title = entry.title;
94
+ this.subsystems = entry.subsystems;
95
+ this.revert = entry.revert;
96
+ this.author = entry.author;
97
+ }
98
+ toJSON() {
99
+ return {
100
+ number: this.number,
101
+ url: this.url,
102
+ title: this.title,
103
+ subsystems: this.subsystems,
104
+ author: this.author,
105
+ semver: this.semver,
106
+ revert: this.revert,
107
+ commits: this.commits.map(({ hash, date, author, subject, files }) => ({ hash, date, author, subject, files })),
108
+ releases: this.releases,
109
+ versions: this.versions,
110
+ areas: this.areas,
111
+ tags: this.tags,
112
+ apis: this.apis,
113
+ };
114
+ }
115
+ }
116
+ /**
117
+ * Adds `id` to `target`, unless it is in `opposite`, in which case the two cancel out.
118
+ */
119
+ function toggle(target, opposite, id) {
120
+ const index = opposite.indexOf(id);
121
+ if (index != -1)
122
+ opposite.splice(index, 1);
123
+ else if (!target.includes(id))
124
+ target.push(id);
125
+ }
@@ -0,0 +1,18 @@
1
+ import { JSONFileMap } from 'utilium/fs';
2
+ export type Mark = 'resolved' | 'ignored';
3
+ export type MarkEntry = {
4
+ status: Mark;
5
+ note?: string;
6
+ /** ISO date */
7
+ date: string;
8
+ };
9
+ /**
10
+ * Manual marks on PRs (`#<number>`) and APIs (by ID), backed by a JSON file.
11
+ */
12
+ export type Marks = Map<string, MarkEntry>;
13
+ export declare const defaultMarksPath = ".node-compat.json";
14
+ /**
15
+ * Opens a marks file, creating it if needed.
16
+ */
17
+ export declare function openMarks(path?: string): JSONFileMap<MarkEntry>;
18
+ export declare function createMark(status: Mark, note?: string): MarkEntry;
@@ -0,0 +1,12 @@
1
+ // SPDX-License-Identifier: LGPL-3.0-or-later
2
+ import { JSONFileMap } from 'utilium/fs';
3
+ export const defaultMarksPath = '.node-compat.json';
4
+ /**
5
+ * Opens a marks file, creating it if needed.
6
+ */
7
+ export function openMarks(path = defaultMarksPath) {
8
+ return new JSONFileMap(path, { overwrite_invalid: false });
9
+ }
10
+ export function createMark(status, note) {
11
+ return { status, ...(note && { note }), date: new Date().toISOString().slice(0, 10) };
12
+ }
@@ -0,0 +1,5 @@
1
+ /**
2
+ * @param version A full or partial version, optionally prefixed with `v`
3
+ */
4
+ export declare function parseVersion(version: string): [major: number, minor: number, patch: number];
5
+ export declare function compareVersions(left: string, right: string): number;
@@ -0,0 +1,13 @@
1
+ // SPDX-License-Identifier: LGPL-3.0-or-later
2
+ /**
3
+ * @param version A full or partial version, optionally prefixed with `v`
4
+ */
5
+ export function parseVersion(version) {
6
+ const [major = 0, minor = 0, patch = 0] = version.replace(/^v/, '').split('.').map(Number);
7
+ return [major, minor, patch];
8
+ }
9
+ export function compareVersions(left, right) {
10
+ const [leftMajor, leftMinor, leftPatch] = parseVersion(left);
11
+ const [rightMajor, rightMinor, rightPatch] = parseVersion(right);
12
+ return leftMajor - rightMajor || leftMinor - rightMinor || leftPatch - rightPatch;
13
+ }
@@ -0,0 +1,3 @@
1
+ import type { Api } from './docs.js';
2
+ export declare const version: string;
3
+ export declare function has(api: Api): boolean;
@@ -0,0 +1,108 @@
1
+ var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
2
+ if (value !== null && value !== void 0) {
3
+ if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
4
+ var dispose, inner;
5
+ if (async) {
6
+ if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
7
+ dispose = value[Symbol.asyncDispose];
8
+ }
9
+ if (dispose === void 0) {
10
+ if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
11
+ dispose = value[Symbol.dispose];
12
+ if (async) inner = dispose;
13
+ }
14
+ if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
15
+ if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
16
+ env.stack.push({ value: value, dispose: dispose, async: async });
17
+ }
18
+ else if (async) {
19
+ env.stack.push({ async: true });
20
+ }
21
+ return value;
22
+ };
23
+ var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
24
+ return function (env) {
25
+ function fail(e) {
26
+ env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
27
+ env.hasError = true;
28
+ }
29
+ var r, s = 0;
30
+ function next() {
31
+ while (r = env.stack.pop()) {
32
+ try {
33
+ if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
34
+ if (r.dispose) {
35
+ var result = r.dispose.call(r.value);
36
+ if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
37
+ }
38
+ else s |= 1;
39
+ }
40
+ catch (e) {
41
+ fail(e);
42
+ }
43
+ }
44
+ if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
45
+ if (env.hasError) throw env.error;
46
+ }
47
+ return next();
48
+ };
49
+ })(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
50
+ var e = new Error(message);
51
+ return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
52
+ });
53
+ // SPDX-License-Identifier: LGPL-3.0-or-later
54
+ import * as zenfs from '@zenfs/core';
55
+ function attempt(create) {
56
+ try {
57
+ return create();
58
+ }
59
+ catch {
60
+ return undefined;
61
+ }
62
+ }
63
+ export const version = zenfs._version;
64
+ export function has(api) {
65
+ let target = targets[api.owner];
66
+ if (target == null)
67
+ return false;
68
+ for (const key of api.path) {
69
+ if ((typeof target != 'object' && typeof target != 'function') || target === null || !(key in target))
70
+ return false;
71
+ target = target[key];
72
+ }
73
+ return true;
74
+ }
75
+ var stack, dir, file, targets;
76
+ const env_1 = { stack: [], error: void 0, hasError: false };
77
+ try {
78
+ stack = __addDisposableResource(env_1, new AsyncDisposableStack(), true);
79
+ dir = '/.node-compat-probe';
80
+ file = dir + '/file';
81
+ zenfs.rmSync(dir, { recursive: true, force: true });
82
+ zenfs.mkdirSync(dir, { recursive: true });
83
+ stack.defer(() => zenfs.rmSync(dir, { recursive: true, force: true }));
84
+ zenfs.writeFileSync(file, 'probe');
85
+ targets = {
86
+ fs: zenfs,
87
+ fsPromises: zenfs.promises,
88
+ FileHandle: stack.use(await zenfs.promises.open(file).catch(() => undefined)),
89
+ Dir: stack.use(attempt(() => zenfs.opendirSync(dir))),
90
+ Dirent: attempt(() => zenfs.readdirSync(dir, { withFileTypes: true })[0]),
91
+ FSWatcher: stack.adopt(attempt(() => zenfs.watch(dir)), watcher => watcher?.close()),
92
+ StatWatcher: stack.adopt(attempt(() => zenfs.watchFile(file, () => { })), () => zenfs.unwatchFile(file)),
93
+ ReadStream: stack.use(attempt(() => zenfs.createReadStream(file))),
94
+ WriteStream: stack.use(attempt(() => zenfs.createWriteStream(dir + '/write'))),
95
+ Stats: attempt(() => zenfs.statSync(file)),
96
+ StatFs: attempt(() => zenfs.statfsSync(dir)),
97
+ Utf8Stream: stack.use(attempt(() => new zenfs.Utf8Stream({ dest: dir + '/utf8', sync: true }))),
98
+ };
99
+ }
100
+ catch (e_1) {
101
+ env_1.error = e_1;
102
+ env_1.hasError = true;
103
+ }
104
+ finally {
105
+ const result_1 = __disposeResources(env_1);
106
+ if (result_1)
107
+ await result_1;
108
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zenfs/devel",
3
- "version": "0.1.0",
3
+ "version": "1.0.0",
4
4
  "description": "Tooling for developing ZenFS packages",
5
5
  "funding": {
6
6
  "type": "individual",
@@ -14,6 +14,7 @@
14
14
  ],
15
15
  "bin": {
16
16
  "make-index": "dist/bin/make-index.js",
17
+ "node-compat": "dist/bin/node-compat.js",
17
18
  "zenfs-test": "dist/bin/zenfs-test.js",
18
19
  "zci": "dist/bin/zci.js"
19
20
  },
@@ -34,10 +35,12 @@
34
35
  "url": "https://github.com/zen-fs/devel/issues"
35
36
  },
36
37
  "engines": {
37
- "node": ">= 22"
38
+ "node": ">= 24"
38
39
  },
39
40
  "exports": {
40
41
  "./eslint": "./eslint.shared.js",
42
+ ".": "./dist/index.js",
43
+ "./node_compat": "./dist/node_compat.js",
41
44
  "./*": "./dist/*.js"
42
45
  },
43
46
  "publishConfig": {
@@ -60,6 +63,7 @@
60
63
  "@octokit/action": "^8.0.4",
61
64
  "buffer": "^6.0.3",
62
65
  "c8": "^12.0.0",
66
+ "commander": "^15.0.0",
63
67
  "globals": "^17.3.0",
64
68
  "kerium": "^1.5.0",
65
69
  "typescript-eslint": "^8.58.0",
@@ -75,6 +79,7 @@
75
79
  }
76
80
  },
77
81
  "devDependencies": {
82
+ "@commander-js/extra-typings": "^15.0.0",
78
83
  "@types/node": "^26.0.0",
79
84
  "@zenfs/core": "^2.8.0",
80
85
  "eslint": "^10.1.0",