chore(v2): fix several lint warnings, add missing types, cleanup

packages/docusaurus-cssnano-preset/src/remove-overridden-custom-properties/index.js

@@ -28,11 +28,13 @@ module.exports = postcss.plugin(
         const sameProperties =
           decl.parent.nodes.filter((n) => n.prop === decl.prop) || [];
         const hasImportantProperties = sameProperties.some((p) =>
-          p.hasOwnProperty('important'),
+          Object.prototype.hasOwnProperty.call(p, 'important'),
         );
 
         const overriddenProperties = hasImportantProperties
-          ? sameProperties.filter((p) => !p.hasOwnProperty('important'))
+          ? sameProperties.filter(
+              (p) => !Object.prototype.hasOwnProperty.call(p, 'important'),
+            )
           : sameProperties.slice(0, -1);
 
         overriddenProperties.map((p) => p.remove());

packages/docusaurus-mdx-loader/src/remark/transformImage/index.js

@@ -18,21 +18,22 @@ const {
 } = getFileLoaderUtils();
 
 const createJSX = (node, pathUrl) => {
-  node.type = 'jsx';
-  node.value = `<img ${node.alt ? `alt={"${escapeHtml(node.alt)}"} ` : ''}${
+  const jsxNode = node;
+  jsxNode.type = 'jsx';
+  jsxNode.value = `<img ${node.alt ? `alt={"${escapeHtml(node.alt)}"} ` : ''}${
     node.url
       ? `src={require("${inlineMarkdownImageFileLoader}${pathUrl}").default}`
       : ''
   }${node.title ? ` title="${escapeHtml(node.title)}"` : ''} />`;
 
-  if (node.url) {
-    delete node.url;
+  if (jsxNode.url) {
+    delete jsxNode.url;
   }
-  if (node.alt) {
-    delete node.alt;
+  if (jsxNode.alt) {
+    delete jsxNode.alt;
   }
-  if (node.title) {
-    delete node.title;
+  if (jsxNode.title) {
+    delete jsxNode.title;
   }
 };
 

packages/docusaurus-migrate/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/migrate",
   "version": "2.0.0-alpha.69",
-  "description": "A cli tool to migrate between different version of docusuarus",
+  "description": "A cli tool to migrate between different version of Docusuarus",
   "main": "lib/index.js",
   "license": "MIT",
   "engines": {
@@ -43,6 +43,7 @@
     "unist-util-visit": "^2.0.2"
   },
   "devDependencies": {
+    "@types/color": "^3.0.1",
     "@types/jscodeshift": "^0.7.1"
   }
 }

packages/docusaurus-migrate/src/index.ts

@@ -12,10 +12,10 @@ import glob from 'glob';
 import Color from 'color';
 
 import {
-  VersionOneConfig,
-  VersionTwoConfig,
   ClassicPresetEntries,
   SidebarEntries,
+  VersionOneConfig,
+  VersionTwoConfig,
 } from './types';
 import extractMetadata, {shouldQuotifyFrontMatter} from './frontMatter';
 import migratePage from './transform';
@@ -229,9 +229,9 @@ export function createConfigFile({
   const homePageId = siteConfig.headerLinks?.filter((value) => value.doc)[0]
     .doc;
 
-  const customConfigFields: Record<string, any> = {};
+  const customConfigFields: Record<string, unknown> = {};
   // add fields that are unknown to v2 to customConfigFields
-  Object.keys(siteConfig).forEach((key: any) => {
+  Object.keys(siteConfig).forEach((key) => {
     const knownFields = [
       'title',
       'tagline',
@@ -289,7 +289,7 @@ export function createConfigFile({
     v2DocsPath = path.relative(newDir, absoluteDocsPath);
   }
 
-  const result: VersionTwoConfig = {
+  return {
     title: siteConfig.title ?? '',
     tagline: siteConfig.tagline,
     url: siteConfig.url ?? '',
@@ -330,22 +330,24 @@ export function createConfigFile({
           : undefined,
         items: (siteConfig.headerLinks ?? [])
           .map((link) => {
-            if (link.doc) {
+            const {doc, href, label, page} = link;
+            const position = 'left';
+            if (doc) {
               return {
-                to: `docs/${link.doc === homePageId ? '' : link.doc}`,
-                label: link.label,
-                position: 'left',
+                to: `docs/${doc === homePageId ? '' : doc}`,
+                label,
+                position,
               };
             }
-            if (link.page) {
+            if (page) {
               return {
-                to: `/${link.page}`,
-                label: link.label,
-                position: 'left',
+                to: `/${page}`,
+                label,
+                position,
               };
             }
-            if (link.href) {
-              return {href: link.href, label: link.label, position: 'left'};
+            if (href) {
+              return {href, label, position};
             }
             return null;
           })
@@ -379,7 +381,6 @@ export function createConfigFile({
         : undefined,
     },
   };
-  return result;
 }
 
 function createClientRedirects(
@@ -476,7 +477,7 @@ function handleVersioning(
     const loadedVersions: Array<string> = JSON.parse(
       String(fs.readFileSync(path.join(siteDir, 'versions.json'))),
     );
-    fs.copyFile(
+    fs.copyFileSync(
       path.join(siteDir, 'versions.json'),
       path.join(newDir, 'versions.json'),
     );
@@ -732,11 +733,10 @@ function migrateLatestDocs(
   classicPreset: ClassicPresetEntries,
 ): void {
   if (fs.existsSync(path.join(siteDir, '..', 'docs'))) {
-    const docsPath = path.join(
+    classicPreset.docs.path = path.join(
       path.relative(newDir, path.join(siteDir, '..')),
       'docs',
     );
-    classicPreset.docs.path = docsPath;
     const files = walk(path.join(siteDir, '..', 'docs'));
     files.forEach((file) => {
       const content = String(fs.readFileSync(file));
@@ -797,5 +797,5 @@ export async function migrateMDToMDX(
       sanitizedFileContent(String(fs.readFileSync(file)), true),
     );
   });
-  console.log(`Succesfully migrated ${siteDir} to ${newDir}`);
+  console.log(`Successfully migrated ${siteDir} to ${newDir}`);
 }

packages/docusaurus-migrate/src/sanitizeMD.ts

@@ -20,9 +20,7 @@ const tags = htmlTags.reduce((acc: {[key: string]: boolean}, tag) => {
 }, {});
 
 export default function sanitizeMD(code: string): string {
-  const markdownTree = unified()
-    .use(markdown as any)
-    .parse(code);
+  const markdownTree = unified().use(markdown).parse(code);
   visit(markdownTree, 'code', (node) => {
     node.value = `\n<!--${node.value}-->\n`;
   });
@@ -31,12 +29,10 @@ export default function sanitizeMD(code: string): string {
   });
 
   const markdownString = unified()
-    .use(remarkStringify as any, {fence: '`', fences: true})
+    .use(remarkStringify, {fence: '`', fences: true})
     .stringify(markdownTree);
 
-  const htmlTree = unified()
-    .use(parse as any)
-    .parse(markdownString);
+  const htmlTree = unified().use(parse).parse(markdownString);
   visit(htmlTree, 'element', (node) => {
     if (!tags[node.tagName as string]) {
       node.type = 'text';

packages/docusaurus-migrate/src/transform.ts

@@ -5,7 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import jscodeshift from 'jscodeshift';
+import jscodeshift, {
+  ArrowFunctionExpression,
+  AssignmentExpression,
+  ASTPath,
+  Collection,
+  TemplateElement,
+  VariableDeclarator,
+} from 'jscodeshift';
 
 const empty = () =>
   jscodeshift.arrowFunctionExpression(
@@ -18,77 +25,73 @@ const empty = () =>
     ),
   );
 
-const property = (key: string, value: jscodeshift.ArrowFunctionExpression) =>
+const property = (key: string, value: ArrowFunctionExpression) =>
   jscodeshift.objectProperty(jscodeshift.identifier(key), value);
 
-const processCallExpression = (
-  node: jscodeshift.ASTPath<jscodeshift.VariableDeclarator>,
-) => {
+const processCallExpression = (node: ASTPath<VariableDeclarator>) => {
   const args = (node?.value?.init as any)?.arguments[0];
   if (args.type === 'Literal') {
     if (args.value.includes('../../core/CompLibrary')) {
-      const newDeclartor = jscodeshift.variableDeclarator(
+      const newDeclarator = jscodeshift.variableDeclarator(
         node.value.id,
         jscodeshift.objectExpression([
           property('Container', empty()),
           property('GridBlock', empty()),
           property('MarkdownBlock', empty()),
         ]),
       );
-      jscodeshift(node).replaceWith(newDeclartor);
+      jscodeshift(node).replaceWith(newDeclarator);
     }
   }
   if (args.type === 'TemplateLiteral') {
     if (
       args.quasis
-        .map((element: jscodeshift.TemplateElement) => element.value.raw)
+        .map((element: TemplateElement) => element.value.raw)
         .join('')
         .match(/\/core\//)
     ) {
-      const newDeclartor = jscodeshift.variableDeclarator(
+      const newDeclarator = jscodeshift.variableDeclarator(
         node.value.id,
         empty(),
       );
-      jscodeshift(node).replaceWith(newDeclartor);
+      jscodeshift(node).replaceWith(newDeclarator);
     }
   }
 };
 
-const processMemberExpression = (
-  node: jscodeshift.ASTPath<jscodeshift.VariableDeclarator>,
-) => {
+const processMemberExpression = (node: ASTPath<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(
+      const newDeclarator = jscodeshift.variableDeclarator(
         node.value.id,
         jscodeshift.objectExpression([
           property('Container', empty()),
           property('GridBlock', empty()),
           property('MarkdownBlock', empty()),
         ]),
       );
-      jscodeshift(node).replaceWith(newDeclartor);
+      jscodeshift(node).replaceWith(newDeclarator);
     } else if (args.value.match(/server/)) {
-      const newDeclartor = jscodeshift.variableDeclarator(
+      const newDeclarator = jscodeshift.variableDeclarator(
         node.value.id,
         empty(),
       );
-      jscodeshift(node).replaceWith(newDeclartor);
+      jscodeshift(node).replaceWith(newDeclarator);
     }
   }
   if (args.type === 'TemplateLiteral') {
     if (
       args.quasis
-        .map((ele: jscodeshift.TemplateElement) => ele.value.raw)
+        .map((ele: TemplateElement) => ele.value.raw)
         .join('')
         .match(/\/core\//)
     ) {
-      const newDeclartor = jscodeshift.variableDeclarator(
+      const newDeclarator = jscodeshift.variableDeclarator(
         node.value.id,
         empty(),
       );
-      jscodeshift(node).replaceWith(newDeclartor);
+      jscodeshift(node).replaceWith(newDeclarator);
     }
   }
 };
@@ -113,7 +116,7 @@ export default function transformer(file: string): string {
   }
 
   root
-    .find(jscodeshift.AssignmentExpression, {
+    .find(AssignmentExpression, {
       operator: '=',
       left: {
         type: 'MemberExpression',
@@ -164,10 +167,10 @@ export default function transformer(file: string): string {
   return root.toSource();
 }
 
-function getDefaultImportDeclarators(rootAst: jscodeshift.Collection) {
+function getDefaultImportDeclarators(rootAst: Collection) {
   // var ... = require('y')
   return rootAst
-    .find(jscodeshift.VariableDeclarator, {
+    .find(VariableDeclarator, {
       init: {
         callee: {
           name: 'require',
@@ -179,9 +182,9 @@ function getDefaultImportDeclarators(rootAst: jscodeshift.Collection) {
     });
 }
 
-function getNamedImportDeclarators(rootAst: jscodeshift.Collection) {
+function getNamedImportDeclarators(rootAst: Collection) {
   // var ... = require('y').x
-  return rootAst.find(jscodeshift.VariableDeclarator, {
+  return rootAst.find(VariableDeclarator, {
     init: {
       object: {
         callee: {
@@ -192,7 +195,7 @@ function getNamedImportDeclarators(rootAst: jscodeshift.Collection) {
   });
 }
 
-function getImportDeclaratorPaths(variableDeclaration: jscodeshift.Collection) {
+function getImportDeclaratorPaths(variableDeclaration: Collection) {
   const defaultImports = getDefaultImportDeclarators(variableDeclaration);
 
   const namedImports = getNamedImportDeclarators(variableDeclaration);

packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts

@@ -85,11 +85,11 @@ It is not possible to redirect the same pathname to multiple destinations:
       }
     },
   );
-  redirects = uniqBy(redirects, (redirect) => redirect.from);
+  const collectedRedirects = uniqBy(redirects, (redirect) => redirect.from);
 
   // We don't want to override an already existing route with a redirect file!
-  const redirectsOverridingExistingPath = redirects.filter((redirect) =>
-    pluginContext.relativeRoutesPaths.includes(redirect.from),
+  const redirectsOverridingExistingPath = collectedRedirects.filter(
+    (redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from),
   );
   if (redirectsOverridingExistingPath.length > 0) {
     console.error(
@@ -100,11 +100,9 @@ It is not possible to redirect the same pathname to multiple destinations:
       ),
     );
   }
-  redirects = redirects.filter(
+  return collectedRedirects.filter(
     (redirect) => !pluginContext.relativeRoutesPaths.includes(redirect.from),
   );
-
-  return redirects;
 }
 
 // For each plugin config option, create the appropriate redirects

packages/docusaurus-plugin-client-redirects/src/createRedirectPageContent.ts

@@ -17,14 +17,14 @@ const getCompiledRedirectPageTemplate = memoize(() => {
   return eta.compile(redirectPageTemplate.trim());
 });
 
-function renderRedirectPageTemplate(data: object) {
+function renderRedirectPageTemplate(data: Record<string, unknown>) {
   const compiled = getCompiledRedirectPageTemplate();
   return compiled(data, eta.defaultConfig);
 }
 
 export default function createRedirectPageContent({
   toUrl,
-}: CreateRedirectPageOptions) {
+}: CreateRedirectPageOptions): string {
   return renderRedirectPageTemplate({
     toUrl: encodeURI(toUrl),
   });