Skip to content

Commit

Permalink
build(docs): make the apiDocumentation rollup plugin work in the buil…
Browse files Browse the repository at this point in the history
…d process
  • Loading branch information
joseacabaneros committed Aug 22, 2024
1 parent 4892454 commit 34f24bd
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 83 deletions.
6 changes: 0 additions & 6 deletions packages/x-components/build/postcss-dir-pseudo-class.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions packages/x-components/build/postcss-logical.d.ts

This file was deleted.

4 changes: 0 additions & 4 deletions packages/x-components/build/postcss-types/options.ts

This file was deleted.

5 changes: 2 additions & 3 deletions packages/x-components/build/rollup.config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import path from 'path';
import commonjs from '@rollup/plugin-commonjs';
import { sync as glob } from 'glob';
import { RollupOptions, Plugin } from 'rollup';
import copy from 'rollup-plugin-copy';
Expand All @@ -8,6 +7,7 @@ import styles from 'rollup-plugin-styles';
import typescript from 'rollup-plugin-typescript2';
import vue3 from '@vitejs/plugin-vue';
import { dependencies as pkgDeps, peerDependencies as pkgPeerDeps } from '../package.json';
import { apiDocumentation } from './docgen/documentation.rollup-plugin';
import { importTokens, omitJsFiles } from './rollup-plugins/design-system.rollup-plugin';
import { generateEntryFiles } from './rollup-plugins/x-components.rollup-plugin';

Expand Down Expand Up @@ -97,9 +97,8 @@ export const rollupConfig: RollupOptions = {
]
}),
vueDocs,
commonjs(),
generateEntryFiles({ buildPath, jsOutputDir, typesOutputDir }),
// apiDocumentation({ buildPath }),
apiDocumentation({ buildPath }),
copy({
targets: [
{ src: ['build/tools'], dest: buildPath },
Expand Down
1 change: 0 additions & 1 deletion packages/x-components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@
"@empathyco/x-tailwindcss": "^1.2.0-alpha.5",
"@microsoft/api-documenter": "~7.23.0",
"@microsoft/api-extractor": "~7.39.0",
"@rollup/plugin-commonjs": "~25.0.7",
"@testing-library/jest-dom": "~5.17.0",
"@types/autoprefixer": "~10.2.0",
"@types/glob": "~8.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Result, ResultVariant } from '@empathyco/x-types';
import { ListItem } from '../../utils/types';

/**
* Type of the key passed to {@link XProvide} and {@link XInject} to be type-safe. With this type
* Type of the key passed to `provide` and `inject` to be type-safe. With this type
* you can declare the type of the injected value directly in the injection key.
*
* @example
Expand Down
8 changes: 0 additions & 8 deletions packages/x-components/src/shims-tsx.d.ts

This file was deleted.

2 changes: 1 addition & 1 deletion packages/x-components/src/shims-vue.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
declare module '*.vue' {
import { DefineComponent } from 'vue';
const component: DefineComponent<{}, {}, any>;
const component: DefineComponent;
export default component;
}
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,8 @@ export class QuerySuggestionsGetter implements GettersClass<QuerySuggestionsXSto

const querySuggestionsGetter = new QuerySuggestionsGetter();

// eslint-disable-next-line jsdoc/require-description-complete-sentence
/**.
* {@inheritDoc QuerySuggestionsGetter.querySuggestions}
/**
* Query Suggestions getter.
*
* @public
*/
Expand Down
54 changes: 4 additions & 50 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 34f24bd

Please sign in to comment.