@hia-doc/jsdoc-doc-source-map 0.0.0-stage → 1.0.0-rc.1
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.
- package/LICENSE +21 -0
- package/MIGRATION.md +50 -0
- package/README.md +44 -2
- package/package.json +33 -4
- package/src/index.mjs +21 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 HIA
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/MIGRATION.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Moving to the 1.0.0 source candidates
|
|
2
|
+
|
|
3
|
+
中文摘要:八个umbrella包及独立插件/主题均协调为1.0.0源码候选,公开runtime依赖精确1.0.0。源码开发根保持private,使用固定Git提交的file tarball开发依赖与冻结锁;公开消费者无需这套准备。实际npm发布、站点/视觉验收及目标采用分别核验。
|
|
4
|
+
|
|
5
|
+
## Versions and previous inputs
|
|
6
|
+
|
|
7
|
+
Package versions, runner/producer tool versions and plugin/theme dependency
|
|
8
|
+
metadata now identify 1.0.0. Published 0.x archives remain unchanged. Root imports,
|
|
9
|
+
staged producer, two schema JSON subpaths and hia-jsdoc CLI remain available.
|
|
10
|
+
Previously private child packages are now public-package source candidates with
|
|
11
|
+
explicit package files, MIT license and public access metadata; the workspace
|
|
12
|
+
root remains private and is not a distribution package.
|
|
13
|
+
|
|
14
|
+
Config/umbrella use 1.0.0, with exact old 0.1.0-draft reading and explicit
|
|
15
|
+
migrateHiaJsdocConfig. Migration creates a detached object or refuses data loss;
|
|
16
|
+
it does not rewrite files. Integration and page-map retain their exact 0.1.0
|
|
17
|
+
compatibility profiles, documentation source maps remain 1.1.0, and shared
|
|
18
|
+
producer/presentation/UI-locale identities remain 1.0.0. Never relabel old wire
|
|
19
|
+
objects solely to match the package version.
|
|
20
|
+
|
|
21
|
+
Project execution enforces effective output boundaries, declared input types,
|
|
22
|
+
unique profile IDs and public failure summaries. Rejected plugin-path diagnostics
|
|
23
|
+
omit the original path; hook summaries omit thrown messages while explicit local
|
|
24
|
+
throwOnError preserves the original value. Code parsing those old raw diagnostic
|
|
25
|
+
suffixes must use stable codes and admitted metadata instead. Empty output cannot
|
|
26
|
+
be SDK success; staged copying excludes new private runtime configs and remains
|
|
27
|
+
additive. Trusted plugin execution/raw local errors are not sandboxed or
|
|
28
|
+
automatically safe for publication.
|
|
29
|
+
|
|
30
|
+
See package README references for complete names/defaults/errors/effects and the
|
|
31
|
+
public [API inventory](https://github.com/mandolin/hia-jsdoc/blob/main/API.md).
|
|
32
|
+
Use Node.js ^22.23.4 or ^24.22.1 with tested JSDoc 4.0.5. Earlier runtime versions
|
|
33
|
+
and future upstream parser versions are not inferred compatible.
|
|
34
|
+
|
|
35
|
+
## Frozen source development before registry publication
|
|
36
|
+
|
|
37
|
+
Place this source checkout beside jsdoc-plugin-hia-sys and jsdoc-theme-hia at the
|
|
38
|
+
exact commits in owner-sources.json. Run `npm run prepare:owners`, then `npm ci`.
|
|
39
|
+
Preparation uses existing Git/tar/local npm, disables lifecycle scripts, and
|
|
40
|
+
writes only ignored .owner-packages in this repository. It checks exact origin,
|
|
41
|
+
HEAD, package identity and prelocked SHA/SRI. It never fetches/checks out owners,
|
|
42
|
+
rewrites their manifests or fixes the lock silently. Wrong checkouts and corrupt
|
|
43
|
+
caches are rejected. The two exact HTTPS origin forms with/without .git work.
|
|
44
|
+
|
|
45
|
+
Only this private development root uses file-tarball devDependencies. All shipped
|
|
46
|
+
first-party runtime edges are exact ordinary 1.0.0 dependencies. Original candidate
|
|
47
|
+
tarballs can be consumed together without editing their manifests. Until actual
|
|
48
|
+
publication is verified, do not assume npm registry installation of 1.0.0 exists.
|
|
49
|
+
Publishing/provenance, dist-tags and a clean site deployment remain separate
|
|
50
|
+
release decisions; source qualification does not perform them.
|
package/README.md
CHANGED
|
@@ -1,3 +1,45 @@
|
|
|
1
|
-
#
|
|
1
|
+
# JSDoc Doc Source Map
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
New `createJsdocDocSourceMapRef()` values carry umbrella `profileVersion: "1.0.0"`.
|
|
4
|
+
This metadata helper does not change the actual `doc-source-map@1.1.0` artifact,
|
|
5
|
+
infer source precision, migrate saved references or authorize disclosure. Existing
|
|
6
|
+
saved reference objects remain unchanged; their profile version is not the map
|
|
7
|
+
wire version.
|
|
8
|
+
|
|
9
|
+
中文:新引用的profileVersion随umbrella为1.0.0;它不是地图wire版本或精度证明,旧引用不自动改写。
|
|
10
|
+
|
|
11
|
+
## Supported runtime
|
|
12
|
+
|
|
13
|
+
Current source supports Node.js `^22.23.4 || ^24.22.1`. Release checks use
|
|
14
|
+
Node.js 22.23.4 and 24.22.1 on Windows and Ubuntu; actual package qualification
|
|
15
|
+
and npm availability remain separate. The repository default is Node.js 24.22.1.
|
|
16
|
+
|
|
17
|
+
中文:当前源码运行范围为上述两条已确认版本线,CI/安装验收与实际npm发布分别核对。
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
Defines JSDoc documentation source-map inputs.
|
|
21
|
+
|
|
22
|
+
The current slice only exposes a source-map reference helper. TS/CoffeeScript/LiveScript generated JS linkage remains a later bridge task.
|
|
23
|
+
|
|
24
|
+
## Public API
|
|
25
|
+
|
|
26
|
+
`createJsdocDocSourceMapRef` has signature `(options = {})` and returns a new object with kind
|
|
27
|
+
hia-doc-source-map-ref, profile jsdoc, current umbrella profileVersion, href
|
|
28
|
+
(default null) and sourcesContentPolicy (default none). The other policies are
|
|
29
|
+
reference/embed; the helper copies values and is not their semantic validator.
|
|
30
|
+
|
|
31
|
+
**Errors:** there is no filesystem/path/policy validator in this helper. Invalid
|
|
32
|
+
caller object shapes can fail locally; downstream artifact validation is separate.
|
|
33
|
+
|
|
34
|
+
**Side effects:** no reads/writes, source embedding, map generation or coordinate
|
|
35
|
+
inference. This reference cannot establish same-character source-map precision,
|
|
36
|
+
source permission or existence of href. Original stored references are not
|
|
37
|
+
migrated, and actual doc-source-map wire version remains 1.1.0.
|
|
38
|
+
|
|
39
|
+
中文:引用helper只生成元数据,不能把profileVersion当地图wire版本、精度或公开授权。
|
|
40
|
+
|
|
41
|
+
## Package candidate and migration
|
|
42
|
+
|
|
43
|
+
Current source package identity is 1.0.0, with exact matching first-party runtime dependencies and public access metadata. See the shipped [migration guide](MIGRATION.md). Actual npm publication is verified separately; do not assume an unpublished registry version is available.
|
|
44
|
+
|
|
45
|
+
中文:当前包为1.0.0源码候选,永久依赖与版本元数据协调;实际发布另验,旧wire不改号。
|
package/package.json
CHANGED
|
@@ -1,6 +1,35 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hia-doc/jsdoc-doc-source-map",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"description": "
|
|
6
|
-
|
|
3
|
+
"version": "1.0.0-rc.1",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "JSDoc documentation source-map inputs.",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": "./src/index.mjs"
|
|
10
|
+
},
|
|
11
|
+
"dependencies": {
|
|
12
|
+
"@hia-doc/jsdoc-spec": "1.0.0-rc.1"
|
|
13
|
+
},
|
|
14
|
+
"engines": {
|
|
15
|
+
"node": "^22.23.4 || ^24.22.1"
|
|
16
|
+
},
|
|
17
|
+
"publishConfig": {
|
|
18
|
+
"access": "public"
|
|
19
|
+
},
|
|
20
|
+
"repository": {
|
|
21
|
+
"directory": "packages/jsdoc-doc-source-map",
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "git+https://github.com/mandolin/hia-jsdoc.git"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://github.com/mandolin/hia-jsdoc/tree/main/packages/jsdoc-doc-source-map",
|
|
26
|
+
"bugs": {
|
|
27
|
+
"url": "https://github.com/mandolin/hia-jsdoc/issues"
|
|
28
|
+
},
|
|
29
|
+
"files": [
|
|
30
|
+
"src",
|
|
31
|
+
"README.md",
|
|
32
|
+
"MIGRATION.md",
|
|
33
|
+
"LICENSE"
|
|
34
|
+
]
|
|
35
|
+
}
|
package/src/index.mjs
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { HIA_JSDOC_UMBRELLA_CONTRACT_VERSION } from "@hia-doc/jsdoc-spec";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Creates a neutral doc-source-map reference object for JSDoc-derived artifacts.
|
|
5
|
+
*
|
|
6
|
+
* @param {object} [options] <lang><zh-CN>可选引用配置。</zh-CN><en>Optional reference configuration.</en></lang>
|
|
7
|
+
* @param {string|null} [options.href] <lang><zh-CN>指向 documentation source map manifest 的链接。</zh-CN><en>Link to the documentation source map manifest.</en></lang>
|
|
8
|
+
* @param {"none"|"reference"|"embed"} [options.sourcesContentPolicy="none"] <lang><zh-CN>源码内容策略,默认不内嵌源码。</zh-CN><en>Source content policy; source text is not embedded by default.</en></lang>
|
|
9
|
+
* @returns {object} <lang><zh-CN>可放入 JSDoc artifact metadata 的 source map 引用。</zh-CN><en>A source map reference suitable for JSDoc artifact metadata.</en></lang>
|
|
10
|
+
* @lang zh-CN 创建面向 JSDoc 产物的中性 documentation source map 引用对象。
|
|
11
|
+
* @lang en Creates a neutral doc-source-map reference object for JSDoc-derived artifacts.
|
|
12
|
+
*/
|
|
13
|
+
export function createJsdocDocSourceMapRef(options = {}) {
|
|
14
|
+
return {
|
|
15
|
+
kind: "hia-doc-source-map-ref",
|
|
16
|
+
profile: "jsdoc",
|
|
17
|
+
profileVersion: HIA_JSDOC_UMBRELLA_CONTRACT_VERSION,
|
|
18
|
+
href: options.href ?? null,
|
|
19
|
+
sourcesContentPolicy: options.sourcesContentPolicy ?? "none"
|
|
20
|
+
};
|
|
21
|
+
}
|