Skip to content

Commit e41842f

Browse files
bteabtea
committed
refactor(core): replace parent-relative imports with # package imports
1 parent 31333d8 commit e41842f

23 files changed

Lines changed: 78 additions & 52 deletions

File tree

‎packages/core/package.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,24 @@
3030
"./src/*.d.ts"
3131
]
3232
},
33+
"imports": {
34+
"#generators/*": [
35+
"./src/generators/*",
36+
"./src/generators/*.d.ts"
37+
],
38+
"#logger/*": [
39+
"./src/logger/*",
40+
"./src/logger/*.d.ts"
41+
],
42+
"#parsers/*": [
43+
"./src/parsers/*",
44+
"./src/parsers/*.d.ts"
45+
],
46+
"#utils/*": [
47+
"./src/utils/*",
48+
"./src/utils/*.d.ts"
49+
]
50+
},
3351
"files": [
3452
"src",
3553
"!src/**/*.test.mjs",

‎packages/core/src/generators/ast-js/generate.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { extname } from 'node:path';
66
import { parse } from 'acorn';
77
import { globSync } from 'tinyglobby';
88

9-
import getConfig from '../../utils/configuration/index.mjs';
9+
import getConfig from '#utils/configuration/index.mjs';
1010

1111
/**
1212
* Process a chunk of JavaScript files in a worker thread.

‎packages/core/src/generators/ast/generate.mjs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ import globParent from 'glob-parent';
77
import { globSync } from 'tinyglobby';
88
import { parse as parseYaml } from 'yaml';
99

10+
import getConfig from '#utils/configuration/index.mjs';
11+
import { withExt } from '#utils/file.mjs';
12+
import { QUERIES } from '#utils/queries/index.mjs';
13+
import { getRemark as remark, getRemarkMdx } from '#utils/remark.mjs';
14+
1015
import { STABILITY_INDEX_URL } from './constants.mjs';
11-
import getConfig from '../../utils/configuration/index.mjs';
12-
import { withExt } from '../../utils/file.mjs';
13-
import { QUERIES } from '../../utils/queries/index.mjs';
14-
import { getRemark as remark, getRemarkMdx } from '../../utils/remark.mjs';
1516

1617
/**
1718
* Determines whether a file should be parsed as MDX. A `.mdx` extension opts in

‎packages/core/src/generators/json-simple/generate.mjs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import { join } from 'node:path';
44

55
import { remove } from 'unist-util-remove';
66

7-
import getConfig from '../../utils/configuration/index.mjs';
8-
import { writeFile } from '../../utils/file.mjs';
9-
import { UNIST } from '../../utils/queries/index.mjs';
7+
import getConfig from '#utils/configuration/index.mjs';
8+
import { writeFile } from '#utils/file.mjs';
9+
import { UNIST } from '#utils/queries/index.mjs';
1010

1111
/**
1212
* Generates the simplified JSON version of the API docs

‎packages/core/src/generators/metadata/generate.mjs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
'use strict';
22

3+
import getConfig from '#utils/configuration/index.mjs';
4+
import { loadFromURL } from '#utils/loaders.mjs';
5+
36
import { parseApiDoc } from './utils/parse.mjs';
4-
import getConfig from '../../utils/configuration/index.mjs';
5-
import { loadFromURL } from '../../utils/loaders.mjs';
67

78
/**
89
* Process a chunk of API doc files in a worker thread.

‎packages/core/src/generators/metadata/utils/parse.mjs‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ import { remove } from 'unist-util-remove';
99
import { selectAll } from 'unist-util-select';
1010
import { SKIP, visit } from 'unist-util-visit';
1111

12+
import {
13+
DEPRECATION_HEADING_REGEX,
14+
IGNORE_STABILITY_STEMS,
15+
} from '#generators/metadata/constants.mjs';
16+
import { UNIST } from '#utils/queries/index.mjs';
17+
import { getRemark as remark } from '#utils/remark.mjs';
18+
import { relative } from '#utils/url.mjs';
19+
20+
import { resolveTypeAnnotations } from './resolveTypes.mjs';
1221
import createNodeSlugger from './slugger.mjs';
1322
import { transformNodeToHeading } from './transformers.mjs';
1423
import {
@@ -18,14 +27,6 @@ import {
1827
visitTextWithUnixManualNode,
1928
visitYAML,
2029
} from './visitors.mjs';
21-
import { UNIST } from '../../../utils/queries/index.mjs';
22-
import { getRemark as remark } from '../../../utils/remark.mjs';
23-
import { relative } from '../../../utils/url.mjs';
24-
import {
25-
DEPRECATION_HEADING_REGEX,
26-
IGNORE_STABILITY_STEMS,
27-
} from '../constants.mjs';
28-
import { resolveTypeAnnotations } from './resolveTypes.mjs';
2930

3031
/**
3132
* This generator generates a flattened list of metadata entries from a API doc

‎packages/core/src/generators/metadata/utils/resolveTypes.mjs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
import { parseSync } from '@swc/wasm';
22
import { visit } from 'unist-util-visit';
33

4+
import logger from '#logger/index.mjs';
5+
import { walk } from '#utils/swc.mjs';
6+
47
import { lookupTypeName, resolveTypeReference } from './transformers.mjs';
5-
import logger from '../../../logger/index.mjs';
6-
import { walk } from '../../../utils/swc.mjs';
78

89
// `null` is a keyword kind in SWC, unlike most parsers which treat it as a literal type
910
const KEYWORDS = new Set([

‎packages/core/src/generators/metadata/utils/slugger.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import GitHubSlugger, { slug as defaultSlugFn } from 'github-slugger';
44

5-
import { DOC_API_SLUGS_REPLACEMENTS } from '../constants.mjs';
5+
import { DOC_API_SLUGS_REPLACEMENTS } from '#generators/metadata/constants.mjs';
66

77
/**
88
* Creates a modified version of the GitHub Slugger

‎packages/core/src/generators/metadata/utils/transformers.mjs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@ import {
22
DOC_MAN_BASE_URL,
33
DOC_API_HEADING_TYPES,
44
MODULE_QUALIFIED_NAME,
5-
} from '../constants.mjs';
5+
} from '#generators/metadata/constants.mjs';
6+
import BUILTIN_TYPE_MAP from '#generators/metadata/maps/builtin.json' with { type: 'json' };
7+
import MDN_TYPE_MAP from '#generators/metadata/maps/mdn.json' with { type: 'json' };
8+
import { transformNodesToString } from '#utils/unist.mjs';
9+
610
import { slug } from './slugger.mjs';
7-
import { transformNodesToString } from '../../../utils/unist.mjs';
8-
import BUILTIN_TYPE_MAP from '../maps/builtin.json' with { type: 'json' };
9-
import MDN_TYPE_MAP from '../maps/mdn.json' with { type: 'json' };
1011

1112
/**
1213
* @param {string} text The inner text

‎packages/core/src/generators/metadata/utils/visitors.mjs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
import { SKIP } from 'unist-util-visit';
44

5+
import { QUERIES } from '#utils/queries/index.mjs';
6+
import { getRemark as remark } from '#utils/remark.mjs';
7+
import { transformNodesToString } from '#utils/unist.mjs';
8+
59
import { transformUnixManualToLink } from './transformers.mjs';
610
import { extractYamlContent, parseYAMLIntoMetadata } from './yaml.mjs';
7-
import { QUERIES } from '../../../utils/queries/index.mjs';
8-
import { getRemark as remark } from '../../../utils/remark.mjs';
9-
import { transformNodesToString } from '../../../utils/unist.mjs';
1011

1112
/**
1213
* Updates a Markdown link into a HTML link for API docs

0 commit comments

Comments
 (0)