Skip to content

Commit cad4218

Browse files
committed
chore(plugin-jsdocs): changes from pr
1 parent 0089b1f commit cad4218

File tree

8 files changed

+11
-103
lines changed

8 files changed

+11
-103
lines changed

e2e/plugin-doc-coverage-e2e/project.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "plugin-doc-coverage-e2e",
2+
"name": "plugin-jsdocs-e2e",
33
"$schema": "../../node_modules/nx/schemas/project-schema.json",
4-
"sourceRoot": "e2e/plugin-doc-coverage-e2e/src",
4+
"sourceRoot": "e2e/plugin-jsdocs-e2e/src",
55
"projectType": "application",
66
"tags": ["scope:plugin", "type:e2e"],
77
"implicitDependencies": ["cli", "plugin-jsdocs"],
@@ -10,13 +10,13 @@
1010
"executor": "@nx/linter:eslint",
1111
"outputs": ["{options.outputFile}"],
1212
"options": {
13-
"lintFilePatterns": ["e2e/plugin-doc-coverage-e2e/**/*.ts"]
13+
"lintFilePatterns": ["e2e/plugin-jsdocs-e2e/**/*.ts"]
1414
}
1515
},
1616
"e2e": {
1717
"executor": "@nx/vite:test",
1818
"options": {
19-
"configFile": "e2e/plugin-doc-coverage-e2e/vite.config.e2e.ts"
19+
"configFile": "e2e/plugin-jsdocs-e2e/vite.config.e2e.ts"
2020
}
2121
}
2222
}

e2e/plugin-doc-coverage-e2e/tests/collect.e2e.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { executeProcess, readJsonFile } from '@code-pushup/utils';
1515
describe('PLUGIN collect report with doc-coverage-plugin NPM package', () => {
1616
const fixturesDir = path.join(
1717
'e2e',
18-
'plugin-doc-coverage-e2e',
18+
'plugin-jsdocs-e2e',
1919
'mocks',
2020
'fixtures',
2121
);

e2e/plugin-doc-coverage-e2e/vite.config.e2e.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { defineConfig } from 'vite';
33
import { tsconfigPathAliases } from '../../tools/vitest-tsconfig-path-aliases.js';
44

55
export default defineConfig({
6-
cacheDir: '../../node_modules/.vite/plugin-doc-coverage-e2e',
6+
cacheDir: '../../node_modules/.vite/plugin-jsdocs-e2e',
77
test: {
88
reporters: ['basic'],
99
testTimeout: 120_000,

packages/plugin-jsdocs/src/lib/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ export const jsDocsPluginConfigSchema = z
3333
: target,
3434
);
3535

36-
export type JsDocsPluginConfig = z.infer<typeof jsDocsPluginConfigSchema>;
36+
export type JsDocsPluginConfig = z.input<typeof jsDocsPluginConfigSchema>;

packages/plugin-jsdocs/src/lib/runner/__snapshots__/doc-processer.unit.test.ts.snap

Lines changed: 0 additions & 92 deletions
This file was deleted.

packages/plugin-jsdocs/src/lib/runner/doc-processor.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020

2121
type Node = {
2222
getKind: () => SyntaxKind;
23-
getName: () => string;
23+
getName: () => string | undefined;
2424
getStartLineNumber: () => number;
2525
getJsDocs: () => JSDoc[];
2626
};
@@ -89,7 +89,7 @@ export function getDocumentationReport(
8989
const allNodesFromFile = getAllNodesFromASourceFile(sourceFile);
9090

9191
const coverageReportOfCurrentFile = getCoverageFromAllNodesOfFile(
92-
allNodesFromFile as Node[],
92+
allNodesFromFile,
9393
filePath,
9494
);
9595

packages/plugin-jsdocs/vite.config.integration.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export default defineConfig({
1515
poolOptions: { threads: { singleThread: true } },
1616
coverage: {
1717
reporter: ['text', 'lcov'],
18-
reportsDirectory: '../../coverage/plugin-doc-coverage/integration-tests',
18+
reportsDirectory: '../../coverage/plugin-jsdocs/integration-tests',
1919
exclude: ['mocks/**', '**/types.ts'],
2020
},
2121
environment: 'node',

packages/plugin-jsdocs/vite.config.unit.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export default defineConfig({
1515
poolOptions: { threads: { singleThread: true } },
1616
coverage: {
1717
reporter: ['text', 'lcov'],
18-
reportsDirectory: '../../coverage/plugin-doc-coverage/unit-tests',
18+
reportsDirectory: '../../coverage/plugin-jsdocs/unit-tests',
1919
exclude: ['mocks/**', '**/types.ts'],
2020
},
2121
environment: 'node',

0 commit comments

Comments
 (0)