arethetypeswrong / arethetypeswrong/arethetypeswrong.github.io
How to check globs in exports
- 主要语言
- TypeScript
- 星标
- 1.6k
- 派生
- 65
- PR 合并指标
- 30 天内没有已合并 PR
描述
I wrote a wrapper around the invocation of attw, some may find it helpful:
```js
async function lintPublishedTypes({ cwd }) {
let manifest = await packageJson.read(cwd);
let name = manifest.name;
let entrypoints = [];
for (let [entryGlob, mapping] of Object.entries(manifest['exports'])) {
if (!entryGlob.includes('*')) {
let entry = path.join(name, entryGlob);
entrypoints.push(entry);
continue;
}
const files = globbySync(mapping.types.replace('*', '**/*'), {cwd});
// Map the files to full module paths
const mappedFiles = files.map(file => {
// Now that we found files, we need to map them _back_ to entrypoints.
// Based on the entryGlob, we need to remove the path leading up until the '*',
let toRemove = mapping.types.split('*')[0];
let moduleName = file.split(toRemove)[1];
// we need to chop off the extension IFF the mapping.types includes it
if (mapping.types.endsWith('.d.ts')) {
moduleName = moduleName.replace('.d.ts', '');
}
return moduleName;
});
entrypoints.push(...mappedFiles);
}
entrypoints = entrypoints
// Remove stuff we are going to exclude
.filter(entry => !entry.endsWith('*'))
.filter(entry => !entry.endsWith('addon-main'))
// Remove index files
.filter(entry => !entry.endsWith('index'));
let args = [
'attw', '--pack',
// This does not provide types
'--exclude-entrypoints', 'addon-main',
// We turn this one off because we don't care about CJS consumers
'--ignore-rules', 'cjs-resolves-to-esm',
// Wildcard is not official supported
'--ignore-rules', 'wildcard',
// publint will handle resolving
'--ignore-rules', 'internal-resolution-error',
'--include-entrypoints', ...entrypoints
];
console.info(chalk.blueBright('Running:\n', args.join(' ')));
await execa('pnpm', args, {
cwd,
stdio: 'inherit',
});
}
```
This takes my exports:
```
"exports": {
".": {
"types": "./dist-types/index.d.ts",
"default": "./dist/index.js"
},
"./*": {
"types": "./dist-types/*.d.ts",
"default": "./dist/*.js"
},
"./test-support": {
"types": "./dist-types/test-support/index.d.ts",
"default": "./dist/test-support/index.js"
},
"./addon-main": "./addon-main.cjs"
},
```
and invokes this command:
```
attw --pack \
--exclude-entrypoints addon-main \
--ignore-rules cjs-resolves-to-esm \
--ignore-rules wildcard \
--ignore-rules internal-resolution-error \
--include-entrypoints \
ember-primitives color-scheme helpers iframe proper-links template-registry utils \
components/dialog components/external-link components/link components/popover components/portal-targets components/portal components/shadowed components/switch components/toggle helpers/service \
test-support/routing \
components/-private/typed-elements components/-private/utils components/dialog/element-state components/dialog/state \
ember-primitives/test-support
```
it's not perfect -- but it's progress
贡献指南
这个仓库没有索引到贡献指南
调研方向
从 issue 中显示的 lintPublishedTypes wrapper 提案和 package exports 映射开始。针对列出的 entrypoint 运行显示的 attw 命令,然后将其对 wildcard exports 的处理与生成的 entrypoint 列表进行比较;当无需手动 workaround 即可可靠地检查通过 glob 获取的 exports 时,就完成了。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, typescript
- 领域
- devtools
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100