refactor: remove a lot of implicit anys (#7468)

This commit is contained in:
Joshua Chen 2022-05-23 15:40:53 +08:00 committed by GitHub
parent 0c8e57de67
commit 3666a2ede5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 148 additions and 163 deletions

View file

@ -14,6 +14,7 @@ import toString from 'mdast-util-to-string';
import visit from 'unist-util-visit';
import slug from '../index';
import type {Plugin} from 'unified';
import type {Parent} from 'unist';
function process(doc: string, plugins: Plugin[] = []) {
const processor = remark().use({plugins: [...plugins, slug]});
@ -58,11 +59,8 @@ describe('headings remark plugin', () => {
it('does not overwrite `data` on headings', () => {
const result = process('# Normal\n', [
() => {
function transform(tree) {
tree.children[0].data = {foo: 'bar'};
}
return transform;
() => (root) => {
(root as Parent).children[0]!.data = {foo: 'bar'};
},
]);
const expected = u('root', [
@ -81,11 +79,10 @@ describe('headings remark plugin', () => {
it('does not overwrite `data.hProperties` on headings', () => {
const result = process('# Normal\n', [
() => {
function transform(tree) {
tree.children[0].data = {hProperties: {className: ['foo']}};
}
return transform;
() => (root) => {
(root as Parent).children[0]!.data = {
hProperties: {className: ['foo']},
};
},
]);
const expected = u('root', [
@ -111,12 +108,9 @@ describe('headings remark plugin', () => {
'## Something also',
].join('\n\n'),
[
() => {
function transform(tree) {
tree.children[1].data = {hProperties: {id: 'here'}};
tree.children[3].data = {hProperties: {id: 'something'}};
}
return transform;
() => (root) => {
(root as Parent).children[1]!.data = {hProperties: {id: 'here'}};
(root as Parent).children[3]!.data = {hProperties: {id: 'something'}};
},
],
);
@ -270,9 +264,9 @@ describe('headings remark plugin', () => {
# {#text-after} custom ID
`);
const headers = [];
const headers: {text: string; id: string}[] = [];
visit(result, 'heading', (node) => {
headers.push({text: toString(node), id: node.data.id});
headers.push({text: toString(node), id: node.data!.id as string});
});
expect(headers).toEqual([

View file

@ -75,50 +75,6 @@ exports[`toc remark plugin exports even with existing name 1`] = `
"
`;
exports[`toc remark plugin exports with custom name 1`] = `
"export const customName = [
{
value: 'Endi',
id: 'endi',
level: 3
},
{
value: 'Endi',
id: 'endi-1',
level: 2
},
{
value: 'Yangshun',
id: 'yangshun',
level: 3
},
{
value: 'I ♥ unicode.',
id: 'i--unicode',
level: 2
}
];
### Endi
\`\`\`md
## This is ignored
\`\`\`
## Endi
Lorem ipsum
### Yangshun
Some content here
## I ♥ unicode.
export const c = 1;
"
`;
exports[`toc remark plugin handles empty headings 1`] = `
"export const toc = [];

View file

@ -12,13 +12,13 @@ import vfile from 'to-vfile';
import plugin from '../index';
import headings from '../../headings/index';
const processFixture = async (name, options?) => {
const processFixture = async (name: string) => {
const filePath = path.join(__dirname, '__fixtures__', `${name}.md`);
const file = await vfile.read(filePath);
const result = await remark()
.use(headings)
.use(mdx)
.use(plugin, options)
.use(plugin)
.process(file);
return result.toString();
@ -45,14 +45,6 @@ describe('toc remark plugin', () => {
expect(result).toMatchSnapshot();
});
it('exports with custom name', async () => {
const options = {
name: 'customName',
};
const result = await processFixture('just-content', options);
expect(result).toMatchSnapshot();
});
it('inserts below imports', async () => {
const result = await processFixture('insert-below-imports');
expect(result).toMatchSnapshot();

View file

@ -23,15 +23,13 @@ const parseOptions: ParserOptions = {
sourceType: 'module',
};
const name = 'toc';
const isImport = (child: Node): child is Literal => child.type === 'import';
const hasImports = (index: number) => index > -1;
const isExport = (child: Node): child is Literal => child.type === 'export';
type PluginOptions = {
name?: string;
};
const isTarget = (child: Literal, name: string) => {
const isTarget = (child: Literal) => {
let found = false;
const ast = parse(child.value, parseOptions);
traverse(ast, {
@ -44,14 +42,14 @@ const isTarget = (child: Literal, name: string) => {
return found;
};
const getOrCreateExistingTargetIndex = (children: Node[], name: string) => {
const getOrCreateExistingTargetIndex = (children: Node[]) => {
let importsIndex = -1;
let targetIndex = -1;
children.forEach((child, index) => {
if (isImport(child)) {
importsIndex = index;
} else if (isExport(child) && isTarget(child, name)) {
} else if (isExport(child) && isTarget(child)) {
targetIndex = index;
}
});
@ -70,9 +68,7 @@ const getOrCreateExistingTargetIndex = (children: Node[], name: string) => {
return targetIndex;
};
export default function plugin(options: PluginOptions = {}): Transformer {
const name = options.name || 'toc';
export default function plugin(): Transformer {
return (root) => {
const headings: TOCItem[] = [];
@ -91,7 +87,7 @@ export default function plugin(options: PluginOptions = {}): Transformer {
});
});
const {children} = root as Parent<Literal>;
const targetIndex = getOrCreateExistingTargetIndex(children, name);
const targetIndex = getOrCreateExistingTargetIndex(children);
if (headings.length) {
children[targetIndex]!.value = `export const ${name} = ${stringifyObject(

View file

@ -10,16 +10,19 @@ import path from 'path';
import remark from 'remark';
import mdx from 'remark-mdx';
import vfile from 'to-vfile';
import plugin from '../index';
import plugin, {type PluginOptions} from '../index';
import headings from '../../headings/index';
const processFixture = async (name, options) => {
const processFixture = async (
name: string,
options: Partial<PluginOptions>,
) => {
const filePath = path.join(__dirname, `__fixtures__/${name}.md`);
const file = await vfile.read(filePath);
const result = await remark()
.use(headings)
.use(mdx)
.use(plugin, {...options, filePath})
.use(plugin, {siteDir: __dirname, staticDirs: [], ...options})
.process(file);
return result.toString();

View file

@ -27,7 +27,7 @@ const {
loaders: {inlineMarkdownImageFileLoader},
} = getFileLoaderUtils();
type PluginOptions = {
export type PluginOptions = {
staticDirs: string[];
siteDir: string;
};

View file

@ -10,9 +10,9 @@ import remark from 'remark';
import mdx from 'remark-mdx';
import vfile from 'to-vfile';
import plugin from '..';
import transformImage from '../../transformImage';
import transformImage, {type PluginOptions} from '../../transformImage';
const processFixture = async (name: string, options?) => {
const processFixture = async (name: string, options?: PluginOptions) => {
const filePath = path.join(__dirname, `__fixtures__/${name}.md`);
const staticDirs = [
path.join(__dirname, '__fixtures__/static'),
@ -24,7 +24,6 @@ const processFixture = async (name: string, options?) => {
.use(transformImage, {...options, filePath, staticDirs})
.use(plugin, {
...options,
filePath,
staticDirs,
siteDir: path.join(__dirname, '__fixtures__'),
})

View file

@ -25,7 +25,7 @@ const {
loaders: {inlineMarkdownLinkFileLoader},
} = getFileLoaderUtils();
type PluginOptions = {
export type PluginOptions = {
staticDirs: string[];
siteDir: string;
};