Skip to content

Commit 66fc277

Browse files
velutvelut
committed
chore: use tabs for formatting
1 parent 54ab951 commit 66fc277

File tree

150 files changed

+4654
-4652
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+4654
-4652
lines changed

Diff for: ‎.prettierrc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
{}
1+
{
2+
"useTabs": true
3+
}

Diff for: ‎.vscode/settings.json

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
{
2-
"cSpell.ignoreWords": [
3-
"arethetypeswrong",
4-
"attw",
5-
"codecov",
6-
"commitlint",
7-
"edoardo",
8-
"execa",
9-
"exome",
10-
"foobarbaz",
11-
"jsdocs",
12-
"keyof",
13-
"kirklin",
14-
"luxass",
15-
"modifierable",
16-
"neverthrow",
17-
"overloadable",
18-
"pathe",
19-
"pollyjs",
20-
"preact",
21-
"scibona",
22-
"storylite",
23-
"supeffective",
24-
"tempy",
25-
"tsdoc",
26-
"tsup",
27-
"velut",
28-
"violentmonkey",
29-
"vitest"
30-
],
31-
"typescript.tsdk": "node_modules/typescript/lib"
2+
"cSpell.ignoreWords": [
3+
"arethetypeswrong",
4+
"attw",
5+
"codecov",
6+
"commitlint",
7+
"edoardo",
8+
"execa",
9+
"exome",
10+
"foobarbaz",
11+
"jsdocs",
12+
"keyof",
13+
"kirklin",
14+
"luxass",
15+
"modifierable",
16+
"neverthrow",
17+
"overloadable",
18+
"pathe",
19+
"pollyjs",
20+
"preact",
21+
"scibona",
22+
"storylite",
23+
"supeffective",
24+
"tempy",
25+
"tsdoc",
26+
"tsup",
27+
"velut",
28+
"violentmonkey",
29+
"vitest"
30+
],
31+
"typescript.tsdk": "node_modules/typescript/lib"
3232
}

Diff for: ‎README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ It downloads packages from the npm registry and analyzes them to extract their p
3434
import { extractPackageApi } from "@jsdocs-io/extractor";
3535

3636
(async () => {
37-
const result = await extractPackageApi({ pkg: "preact" });
38-
if (result.isOk()) {
39-
const packageApi = result.value; // Successfully extracted API
40-
console.log(JSON.stringify(packageApi, null, 2));
41-
} else {
42-
const extractorError = result.error; // Error extracting API
43-
console.error(extractorError);
44-
}
37+
const result = await extractPackageApi({ pkg: "preact" });
38+
if (result.isOk()) {
39+
const packageApi = result.value; // Successfully extracted API
40+
console.log(JSON.stringify(packageApi, null, 2));
41+
} else {
42+
const extractorError = result.error; // Error extracting API
43+
console.error(extractorError);
44+
}
4545
})();
4646
```
4747

@@ -51,14 +51,14 @@ import { extractPackageApi } from "@jsdocs-io/extractor";
5151
import { extractPackageApi } from "@jsdocs-io/extractor";
5252

5353
(async () => {
54-
const result = await extractPackageApi({ pkg: "preact", subpath: "hooks" });
55-
if (result.isOk()) {
56-
const packageApi = result.value; // Successfully extracted API
57-
console.log(JSON.stringify(packageApi, null, 2));
58-
} else {
59-
const extractorError = result.error; // Error extracting API
60-
console.error(extractorError);
61-
}
54+
const result = await extractPackageApi({ pkg: "preact", subpath: "hooks" });
55+
if (result.isOk()) {
56+
const packageApi = result.value; // Successfully extracted API
57+
console.log(JSON.stringify(packageApi, null, 2));
58+
} else {
59+
const extractorError = result.error; // Error extracting API
60+
console.error(extractorError);
61+
}
6262
})();
6363
```
6464

Diff for: ‎package.json

+84-84
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,86 @@
11
{
2-
"name": "@jsdocs-io/extractor",
3-
"version": "1.0.0-1",
4-
"description": "The API extractor for npm packages powering jsdocs.io",
5-
"license": "AGPL-3.0-or-later",
6-
"author": {
7-
"name": "Edoardo Scibona",
8-
"url": "http://github.com/velut"
9-
},
10-
"repository": {
11-
"type": "git",
12-
"url": "https://github.com/jsdocs-io/extractor.git"
13-
},
14-
"bugs": {
15-
"url": "https://github.com/jsdocs-io/extractor/issues"
16-
},
17-
"keywords": [
18-
"npm",
19-
"registry",
20-
"package",
21-
"analyze",
22-
"api",
23-
"extractor",
24-
"documentation",
25-
"generator",
26-
"typescript",
27-
"javascript",
28-
"jsdoc",
29-
"tsdoc",
30-
"jsdocs.io"
31-
],
32-
"sideEffects": false,
33-
"type": "module",
34-
"types": "./dist/index.d.ts",
35-
"exports": {
36-
".": {
37-
"types": "./dist/index.d.ts",
38-
"import": "./dist/index.js"
39-
},
40-
"./package.json": "./package.json"
41-
},
42-
"files": [
43-
"dist"
44-
],
45-
"engines": {
46-
"node": ">=20"
47-
},
48-
"scripts": {
49-
"check": "tsc --noEmit",
50-
"build": "tsc --noEmit && tsup",
51-
"attw": "attw --pack . --ignore-rules cjs-resolves-to-esm",
52-
"test": "vitest run src test/declarations --coverage --bail 1",
53-
"test:ci": "vitest run src test/declarations test/packages --coverage --bail 1",
54-
"lint": "prettier --check .",
55-
"format": "prettier --write .",
56-
"pre-push": "pnpm i && pnpm lint && pnpm build && pnpm test:ci",
57-
"release": "np"
58-
},
59-
"dependencies": {
60-
"@microsoft/tsdoc": "^0.14.2",
61-
"effect": "^2.4.1",
62-
"execa": "^8.0.1",
63-
"memoize": "^10.0.0",
64-
"natural-orderby": "^3.0.2",
65-
"pathe": "^1.1.2",
66-
"prettier": "^3.2.5",
67-
"read-pkg": "^9.0.1",
68-
"resolve.exports": "^2.0.2",
69-
"tempy": "^3.1.0",
70-
"ts-morph": "^21.0.1",
71-
"validate-npm-package-name": "^5.0.0"
72-
},
73-
"devDependencies": {
74-
"@arethetypeswrong/cli": "^0.15.0",
75-
"@total-typescript/shoehorn": "^0.1.1",
76-
"@types/node": "^20.11.20",
77-
"@types/validate-npm-package-name": "^4.0.2",
78-
"@vitest/coverage-v8": "^1.3.1",
79-
"np": "^10.0.0",
80-
"ts-dedent": "^2.2.0",
81-
"tsup": "^8.0.2",
82-
"tsx": "^4.7.1",
83-
"typescript": "^5.3.3",
84-
"vitest": "^1.3.1"
85-
}
2+
"name": "@jsdocs-io/extractor",
3+
"version": "1.0.0-1",
4+
"description": "The API extractor for npm packages powering jsdocs.io",
5+
"license": "AGPL-3.0-or-later",
6+
"author": {
7+
"name": "Edoardo Scibona",
8+
"url": "http://github.com/velut"
9+
},
10+
"repository": {
11+
"type": "git",
12+
"url": "https://github.com/jsdocs-io/extractor.git"
13+
},
14+
"bugs": {
15+
"url": "https://github.com/jsdocs-io/extractor/issues"
16+
},
17+
"keywords": [
18+
"npm",
19+
"registry",
20+
"package",
21+
"analyze",
22+
"api",
23+
"extractor",
24+
"documentation",
25+
"generator",
26+
"typescript",
27+
"javascript",
28+
"jsdoc",
29+
"tsdoc",
30+
"jsdocs.io"
31+
],
32+
"sideEffects": false,
33+
"type": "module",
34+
"types": "./dist/index.d.ts",
35+
"exports": {
36+
".": {
37+
"types": "./dist/index.d.ts",
38+
"import": "./dist/index.js"
39+
},
40+
"./package.json": "./package.json"
41+
},
42+
"files": [
43+
"dist"
44+
],
45+
"engines": {
46+
"node": ">=20"
47+
},
48+
"scripts": {
49+
"check": "tsc --noEmit",
50+
"build": "tsc --noEmit && tsup",
51+
"attw": "attw --pack . --ignore-rules cjs-resolves-to-esm",
52+
"test": "vitest run src test/declarations --coverage --bail 1",
53+
"test:ci": "vitest run src test/declarations test/packages --coverage --bail 1",
54+
"lint": "prettier --check .",
55+
"format": "prettier --write .",
56+
"pre-push": "pnpm i && pnpm lint && pnpm build && pnpm test:ci",
57+
"release": "np"
58+
},
59+
"dependencies": {
60+
"@microsoft/tsdoc": "^0.14.2",
61+
"effect": "^2.4.1",
62+
"execa": "^8.0.1",
63+
"memoize": "^10.0.0",
64+
"natural-orderby": "^3.0.2",
65+
"pathe": "^1.1.2",
66+
"prettier": "^3.2.5",
67+
"read-pkg": "^9.0.1",
68+
"resolve.exports": "^2.0.2",
69+
"tempy": "^3.1.0",
70+
"ts-morph": "^21.0.1",
71+
"validate-npm-package-name": "^5.0.0"
72+
},
73+
"devDependencies": {
74+
"@arethetypeswrong/cli": "^0.15.0",
75+
"@total-typescript/shoehorn": "^0.1.1",
76+
"@types/node": "^20.11.20",
77+
"@types/validate-npm-package-name": "^4.0.2",
78+
"@vitest/coverage-v8": "^1.3.1",
79+
"np": "^10.0.0",
80+
"ts-dedent": "^2.2.0",
81+
"tsup": "^8.0.2",
82+
"tsx": "^4.7.1",
83+
"typescript": "^5.3.3",
84+
"vitest": "^1.3.1"
85+
}
8686
}

Diff for: ‎src/all-extracted-declaration.test.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ import { expect, test } from "vitest";
22
import * as allExtractedDeclaration from "./all-extracted-declaration";
33

44
test("ok", () => {
5-
const declaration: allExtractedDeclaration.AllExtractedDeclaration = {
6-
kind: "variable",
7-
id: "",
8-
name: "",
9-
docs: [],
10-
file: "",
11-
line: 0,
12-
signature: "",
13-
};
14-
expect(declaration.kind).toBe("variable");
5+
const declaration: allExtractedDeclaration.AllExtractedDeclaration = {
6+
kind: "variable",
7+
id: "",
8+
name: "",
9+
docs: [],
10+
file: "",
11+
line: 0,
12+
signature: "",
13+
};
14+
expect(declaration.kind).toBe("variable");
1515
});

Diff for: ‎src/all-extracted-declaration.ts

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
import type {
2-
ExtractedClass,
3-
ExtractedClassConstructor,
4-
ExtractedClassMethod,
5-
ExtractedClassProperty,
2+
ExtractedClass,
3+
ExtractedClassConstructor,
4+
ExtractedClassMethod,
5+
ExtractedClassProperty,
66
} from "./extract-class";
77
import type { ExtractedEnum, ExtractedEnumMember } from "./extract-enum";
88
import type { ExtractedFunction } from "./extract-function";
99
import type {
10-
ExtractedInterface,
11-
ExtractedInterfaceCallSignature,
12-
ExtractedInterfaceConstructSignature,
13-
ExtractedInterfaceGetAccessor,
14-
ExtractedInterfaceIndexSignature,
15-
ExtractedInterfaceMethod,
16-
ExtractedInterfaceProperty,
17-
ExtractedInterfaceSetAccessor,
10+
ExtractedInterface,
11+
ExtractedInterfaceCallSignature,
12+
ExtractedInterfaceConstructSignature,
13+
ExtractedInterfaceGetAccessor,
14+
ExtractedInterfaceIndexSignature,
15+
ExtractedInterfaceMethod,
16+
ExtractedInterfaceProperty,
17+
ExtractedInterfaceSetAccessor,
1818
} from "./extract-interface";
1919
import type { ExtractedNamespace } from "./extract-namespace";
2020
import type { ExtractedTypeAlias } from "./extract-type-alias";
@@ -26,24 +26,24 @@ that can be extracted, with some being found only in other declarations
2626
(e.g., class method declarations are found only in a class declaration).
2727
*/
2828
export type AllExtractedDeclaration =
29-
| ExtractedVariable
30-
| ExtractedFunction
31-
| ExtractedClass
32-
| ExtractedClassConstructor
33-
| ExtractedClassProperty
34-
| ExtractedClassMethod
35-
| ExtractedInterface
36-
| ExtractedInterfaceProperty
37-
| ExtractedInterfaceMethod
38-
| ExtractedInterfaceConstructSignature
39-
| ExtractedInterfaceCallSignature
40-
| ExtractedInterfaceIndexSignature
41-
| ExtractedInterfaceGetAccessor
42-
| ExtractedInterfaceSetAccessor
43-
| ExtractedEnum
44-
| ExtractedEnumMember
45-
| ExtractedTypeAlias
46-
| ExtractedNamespace;
29+
| ExtractedVariable
30+
| ExtractedFunction
31+
| ExtractedClass
32+
| ExtractedClassConstructor
33+
| ExtractedClassProperty
34+
| ExtractedClassMethod
35+
| ExtractedInterface
36+
| ExtractedInterfaceProperty
37+
| ExtractedInterfaceMethod
38+
| ExtractedInterfaceConstructSignature
39+
| ExtractedInterfaceCallSignature
40+
| ExtractedInterfaceIndexSignature
41+
| ExtractedInterfaceGetAccessor
42+
| ExtractedInterfaceSetAccessor
43+
| ExtractedEnum
44+
| ExtractedEnumMember
45+
| ExtractedTypeAlias
46+
| ExtractedNamespace;
4747

4848
/**
4949
`AllExtractedDeclarationKind` is the union of all discriminators

0 commit comments

Comments
 (0)