mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-20 12:37:01 +02:00
feat(v2): v1-v2 migration cli automate migration from v1 to v2 (#3015)
* add poc for migration tool * fix version * fix path * fix some type error * fix type errors * fix commad * delete package.lock.json * ignore lib folder in eslint * ignore lib in prettier * fix missing version * fix sidebar in next * use primaey color * fix navbar link * fix footer * sanatize front-matter for gray-matter * add e2e test * fixworkflow * add unit test * chore(v2): fix eslint error * refactor(v2): use descriptive variable names * refactor(v2): refactor createProjectStructure * refactor(v2): refactor migrateDocusaurusProject * refactor(v2): fix eslint errors * fix(v2): fix mistake * use path.join * remove console.log * try automate migrating md file to mdx * fix types not found * fix types * remove unused fixture * use package.json for version * add support for pages * add support * sanitize fortmatter only in case of special character * chore(v2): add color to dependencies * feat(v2): initialize config with range of color and add logs * chore(v2): add glob dependency * fix(v2): fix color generation * fix(v2): fix type issue * feat(v2): add all unknown fields to customFields * fix(v2): fix css mistake * fix lerna * fix(v2): fix github actions * feat(v2): add option flag for migrating pages * fix special character * remove depulicate build * fix test * remove unwanted file * fix frontmatter * remove unused file * rerun the test * fix links * feat(v2): filter out more fields from customFields * feat(v2): filter out deprecated fields from customFields * fix items * fix types * merge master * revert docs * fix doc * fix broken link * fix test * test * fix ci * fix ci * fix ci * fix ci * fix frontmatter * log custom fields Co-authored-by: teikjun <teikjunhci@gmail.com>
This commit is contained in:
Anshul Goyal
GitHub
parent
0ecd71ec06
commit
a78f703366
52 changed files with 3740 additions and 1368 deletions
201
packages/docusaurus-migrate/src/transform.ts
Normal file
201
packages/docusaurus-migrate/src/transform.ts
Normal file
|
|
@ -0,0 +1,201 @@
|
|||
/**
|
||||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
import jscodeshift from 'jscodeshift';
|
||||
|
||||
const empty = () =>
|
||||
jscodeshift.arrowFunctionExpression(
|
||||
[jscodeshift.identifier('props')],
|
||||
jscodeshift.jsxElement(
|
||||
jscodeshift.jsxOpeningElement(jscodeshift.jsxIdentifier('div'), [
|
||||
jscodeshift.jsxSpreadAttribute(jscodeshift.identifier('props')),
|
||||
]),
|
||||
jscodeshift.jsxClosingElement(jscodeshift.jsxIdentifier('div')),
|
||||
),
|
||||
);
|
||||
|
||||
const property = (key: string, value: jscodeshift.ArrowFunctionExpression) =>
|
||||
jscodeshift.objectProperty(jscodeshift.identifier(key), value);
|
||||
|
||||
const processCallExpression = (
|
||||
node: jscodeshift.ASTPath<jscodeshift.VariableDeclarator>,
|
||||
) => {
|
||||
const args = (node?.value?.init as any)?.arguments[0];
|
||||
if (args.type === 'Literal') {
|
||||
if (args.value.includes('../../core/CompLibrary')) {
|
||||
const newDeclartor = jscodeshift.variableDeclarator(
|
||||
node.value.id,
|
||||
jscodeshift.objectExpression([
|
||||
property('Container', empty()),
|
||||
property('GridBlock', empty()),
|
||||
property('MarkdownBlock', empty()),
|
||||
]),
|
||||
);
|
||||
jscodeshift(node).replaceWith(newDeclartor);
|
||||
}
|
||||
}
|
||||
if (args.type === 'TemplateLiteral') {
|
||||
if (
|
||||
args.quasis
|
||||
.map((element: jscodeshift.TemplateElement) => element.value.raw)
|
||||
.join('')
|
||||
.match(/\/core\//)
|
||||
) {
|
||||
const newDeclartor = jscodeshift.variableDeclarator(
|
||||
node.value.id,
|
||||
empty(),
|
||||
);
|
||||
jscodeshift(node).replaceWith(newDeclartor);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const processMemberExpression = (
|
||||
node: jscodeshift.ASTPath<jscodeshift.VariableDeclarator>,
|
||||
) => {
|
||||
const args = (node?.value?.init as any)?.object?.arguments[0];
|
||||
if (args.type === 'Literal') {
|
||||
if (args.value === '../../core/CompLibrary.js') {
|
||||
const newDeclartor = jscodeshift.variableDeclarator(
|
||||
node.value.id,
|
||||
jscodeshift.objectExpression([
|
||||
property('Container', empty()),
|
||||
property('GridBlock', empty()),
|
||||
property('MarkdownBlock', empty()),
|
||||
]),
|
||||
);
|
||||
jscodeshift(node).replaceWith(newDeclartor);
|
||||
} else if (args.value.match(/server/)) {
|
||||
const newDeclartor = jscodeshift.variableDeclarator(
|
||||
node.value.id,
|
||||
empty(),
|
||||
);
|
||||
jscodeshift(node).replaceWith(newDeclartor);
|
||||
}
|
||||
}
|
||||
if (args.type === 'TemplateLiteral') {
|
||||
if (
|
||||
args.quasis
|
||||
.map((ele: jscodeshift.TemplateElement) => ele.value.raw)
|
||||
.join('')
|
||||
.match(/\/core\//)
|
||||
) {
|
||||
const newDeclartor = jscodeshift.variableDeclarator(
|
||||
node.value.id,
|
||||
empty(),
|
||||
);
|
||||
jscodeshift(node).replaceWith(newDeclartor);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
export default function transformer(file: string): string {
|
||||
const root = jscodeshift(file);
|
||||
const r = getImportDeclaratorPaths(root);
|
||||
r.forEach((node) => {
|
||||
if (node?.value?.init?.type === 'CallExpression') {
|
||||
processCallExpression(node);
|
||||
} else if (node?.value?.init?.type === 'MemberExpression') {
|
||||
processMemberExpression(node);
|
||||
}
|
||||
});
|
||||
if (r[r.length - 1]) {
|
||||
jscodeshift(r[r.length - 1].parent).insertAfter(
|
||||
jscodeshift.importDeclaration(
|
||||
[jscodeshift.importDefaultSpecifier(jscodeshift.identifier('Layout'))],
|
||||
jscodeshift.literal('@theme/Layout'),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
root
|
||||
.find(jscodeshift.AssignmentExpression, {
|
||||
operator: '=',
|
||||
left: {
|
||||
type: 'MemberExpression',
|
||||
object: {
|
||||
name: 'module',
|
||||
},
|
||||
property: {
|
||||
name: 'exports',
|
||||
},
|
||||
},
|
||||
right: {
|
||||
type: 'Identifier',
|
||||
},
|
||||
})
|
||||
.filter(function (p) {
|
||||
return p.parentPath.parentPath.name === 'body';
|
||||
})
|
||||
.forEach(function (p) {
|
||||
const exportDecl = jscodeshift.exportDeclaration(
|
||||
true,
|
||||
jscodeshift.arrowFunctionExpression(
|
||||
[jscodeshift.identifier('props')],
|
||||
jscodeshift.jsxElement(
|
||||
jscodeshift.jsxOpeningElement(
|
||||
jscodeshift.jsxIdentifier('Layout'),
|
||||
[],
|
||||
),
|
||||
jscodeshift.jsxClosingElement(jscodeshift.jsxIdentifier('Layout')),
|
||||
[
|
||||
jscodeshift.jsxElement(
|
||||
jscodeshift.jsxOpeningElement(
|
||||
jscodeshift.jsxIdentifier((p.value.right as any).name),
|
||||
[
|
||||
jscodeshift.jsxSpreadAttribute(
|
||||
jscodeshift.identifier('props'),
|
||||
),
|
||||
],
|
||||
true,
|
||||
),
|
||||
),
|
||||
],
|
||||
),
|
||||
),
|
||||
);
|
||||
exportDecl.comments = p.parentPath.value.comments;
|
||||
jscodeshift(p.parentPath).replaceWith(exportDecl);
|
||||
});
|
||||
return root.toSource();
|
||||
}
|
||||
|
||||
function getDefaultImportDeclarators(rootAst: jscodeshift.Collection) {
|
||||
// var ... = require('y')
|
||||
return rootAst
|
||||
.find(jscodeshift.VariableDeclarator, {
|
||||
init: {
|
||||
callee: {
|
||||
name: 'require',
|
||||
},
|
||||
},
|
||||
})
|
||||
.filter((variableDeclarator) => {
|
||||
return !!variableDeclarator.value;
|
||||
});
|
||||
}
|
||||
|
||||
function getNamedImportDeclarators(rootAst: jscodeshift.Collection) {
|
||||
// var ... = require('y').x
|
||||
return rootAst.find(jscodeshift.VariableDeclarator, {
|
||||
init: {
|
||||
object: {
|
||||
callee: {
|
||||
name: 'require',
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
function getImportDeclaratorPaths(variableDeclaration: jscodeshift.Collection) {
|
||||
const defaultImports = getDefaultImportDeclarators(variableDeclaration);
|
||||
|
||||
const namedImports = getNamedImportDeclarators(variableDeclaration);
|
||||
|
||||
return [...defaultImports.paths(), ...namedImports.paths()];
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue