-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
getComponentInfo.ts
89 lines (80 loc) · 2.77 KB
/
getComponentInfo.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
import fs from 'fs';
import path from 'path';
import kebabCase from 'lodash/kebabCase';
import { getHeaders, getTitle, renderMarkdown } from '@mui/internal-markdown';
import {
ComponentInfo,
extractPackageFile,
getMuiName,
parseFile,
toGitHubPath,
} from '@mui-internal/api-docs-builder/buildApiUtils';
import findPagesMarkdown from '@mui-internal/api-docs-builder/utils/findPagesMarkdown';
export function getComponentInfo(filename: string): ComponentInfo {
const { name } = extractPackageFile(filename);
let srcInfo: null | ReturnType<ComponentInfo['readFile']> = null;
if (!name) {
throw new Error(`Could not find the component name from: ${filename}`);
}
return {
filename,
name,
muiName: getMuiName(name),
apiPathname: `/x/api/date-pickers/${kebabCase(name)}`,
apiPagesDirectory: path.join(process.cwd(), `docs/pages/x/api/date-pickers`),
readFile: () => {
srcInfo = parseFile(filename);
return srcInfo;
},
getInheritance: () => null, // TODO: Support inheritance
getDemos: () => {
const allMarkdowns = findPagesMarkdown(
path.join(__dirname, '../../../docs/data/date-pickers/'),
).map((markdown) => {
const markdownContent = fs.readFileSync(markdown.filename, 'utf8');
const markdownHeaders = getHeaders(markdownContent) as any;
return {
...markdown,
markdownContent,
components: markdownHeaders.components as string[],
};
});
return allMarkdowns
.filter(
(page) => page.pathname.startsWith('/date-pickers') && page.components.includes(name),
)
.map((page) => {
return {
demoPageTitle: renderMarkdown(getTitle(page.markdownContent)),
demoPathname: `${page.pathname.replace('/date-pickers', '/x/react-date-pickers')}/`,
};
});
},
};
}
/**
* Helper to get the import options
* @param name The name of the component
* @param filename The filename where its defined (to infer the package)
* @returns an array of import command
*/
export function getComponentImports(name: string, filename: string) {
const githubPath = toGitHubPath(filename);
const rootImportPath = githubPath.replace(
/\/packages\/(.+?)?\/src\/.*/,
(match, pkg) => `@mui/${pkg}`,
);
const subdirectoryImportPath = githubPath.replace(
/\/packages\/(.+?)?\/src\/([^\\/]+)\/.*/,
(match, pkg, directory) => `@mui/${pkg}/${directory}`,
);
const reExportPackage = [rootImportPath];
// Pickers
if (rootImportPath === '@mui/x-date-pickers') {
reExportPackage.push('@mui/x-date-pickers-pro');
}
return [
`import { ${name} } from '${subdirectoryImportPath}';`,
...reExportPackage.map((importPath) => `import { ${name} } from '${importPath}';`),
];
}