build: added website directory to prettier and eslint checks

Author: kelsonpw

package.json

@@ -74,11 +74,11 @@
     "docs:start": "cd website/ && yarn start",
     "docs:deploy": "cd website/ && yarn deploy",
     "lint": "yarn run lint:prettier && yarn run lint:eslint",
-    "lint:prettier": "prettier --check \"{src,test,scripts}/**/*.js\"",
-    "lint:eslint": "eslint \"{src,test,scripts}/**/*.js\"",
+    "lint:prettier": "prettier --check \"{src,test,scripts,website}/**/*.js\"",
+    "lint:eslint": "eslint \"{src,test,scripts,website}/**/*.js\"",
     "fix": "yarn run fix:eslint && yarn run fix:prettier",
-    "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.js\"",
-    "fix:eslint": "eslint --fix \"{src,test,scripts}/**/*.js\""
+    "fix:prettier": "prettier --write \"{src,test,scripts,website}/**/*.js\"",
+    "fix:eslint": "eslint --fix \"{src,test,scripts,website}/**/*.js\""
   },
   "bugs": {
     "url": "https://github.com/amplitude/amplitude-javascript/issues"
@@ -93,7 +93,7 @@
     }
   },
   "lint-staged": {
-    "{src,test,scripts}/**/*.js": [
+    "{src,test,scripts,website}/**/*.js": [
       "prettier --write",
       "eslint --fix"
     ]

website/docusaurus.config.js

@@ -43,8 +43,7 @@ module.exports = {
           path: 'docs',
           routeBasePath: '/',
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl:
-            'https://github.com/amplitude/Amplitude-JavaScript/website',
+          editUrl: 'https://github.com/amplitude/Amplitude-JavaScript/website',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),

website/generate-jsdoc.js

@@ -1,55 +1,37 @@
-const jsdoc2md = require("jsdoc-to-markdown");
-const fs = require("fs");
-const path = require("path");
-const prettier = require("prettier");
-const publicClassFiles = [
-  "amplitude-client.js",
-  "amplitude.js",
-  "identify.js",
-  "revenue.js",
-];
-const publicTypedefFiles = ["options.js"];
-const srcDir = path.join(__dirname, "../", "src");
-const outputDir = path.join(__dirname, "docs");
+const jsdoc2md = require('jsdoc-to-markdown');
+const fs = require('fs');
+const path = require('path');
+const prettier = require('prettier');
+const publicClassFiles = ['amplitude-client.js', 'amplitude.js', 'identify.js', 'revenue.js'];
+const publicTypedefFiles = ['options.js'];
+const srcDir = path.join(__dirname, '../', 'src');
+const outputDir = path.join(__dirname, 'docs');
 
 function generateTypedefMarkdown(inputFile) {
   const inputFilePath = path.join(srcDir, inputFile);
   const data = jsdoc2md.getTemplateDataSync({ files: inputFilePath });
-  const name = data.find((e) => e.kind === "typedef").name;
-  const filteredData = data.filter((e) => e.kind === "typedef");
-  const outputFilePath = path.join(outputDir, `${name}.md`);
-  const markdownOutput = filteredData
-    .map((item) => documentOptionsFile(item))
-    .join("\n");
-  fs.writeFileSync(
-    path.join(outputDir, `${name}.md`),
-    prettier.format(markdownOutput, { parser: "mdx" })
-  );
+  const name = data.find((e) => e.kind === 'typedef').name;
+  const filteredData = data.filter((e) => e.kind === 'typedef');
+
+  const markdownOutput = filteredData.map((item) => documentOptionsFile(item)).join('\n');
+  fs.writeFileSync(path.join(outputDir, `${name}.md`), prettier.format(markdownOutput, { parser: 'mdx' }));
 }
 
 function generateClassMarkdown(inputFile) {
   const inputFilePath = path.join(srcDir, inputFile);
   const data = jsdoc2md.getTemplateDataSync({ files: inputFilePath });
-  const className = data.find((e) => e.kind === "class").name;
+  const className = data.find((e) => e.kind === 'class').name;
   const filteredData = data.filter(
-    (e) =>
-      e.kind === "constructor" ||
-      (e.access === "public" && (e.kind === "function" || e.kind === "member"))
-  );
-  const outputFilePath = path.join(outputDir, `${className}.md`);
-
-  const markdownOutput = filteredData
-    .map((item) => documentClassFile(item))
-    .join("\n");
-  fs.writeFileSync(
-    path.join(outputDir, `${className}.md`),
-    prettier.format(markdownOutput, { parser: "mdx" })
+    (e) => e.kind === 'constructor' || (e.access === 'public' && (e.kind === 'function' || e.kind === 'member')),
   );
+
+  const markdownOutput = filteredData.map((item) => documentClassFile(item)).join('\n');
+  fs.writeFileSync(path.join(outputDir, `${className}.md`), prettier.format(markdownOutput, { parser: 'mdx' }));
 }
 
 function documentOptionsFile(data) {
   return `${documentHeader(data)}
-  
+
   ${data.description}
 
 Option | Type | Description |	Default
@@ -63,25 +45,25 @@ function documentOptionsProperties(data) {
   return data.properties
     .map(
       (prop) =>
-        `${prop.name || ""} | ${data.properties[0].type.names.join("|")} | ${
-          prop.defaultvalue || ""
-        } | ${prop.description || ""}`
+        `${prop.name || ''} | ${data.properties[0].type.names.join('|')} | ${prop.defaultvalue || ''} | ${
+          prop.description || ''
+        }`,
     )
-    .join("\n");
+    .join('\n');
 }
 
 function documentClassFile(data) {
   return `${documentHeader(data)}
 
-${data.examples ? documentExamples(data) : ""}
+${data.examples ? documentExamples(data) : ''}
 
-${data.description || ""} 
+${data.description || ''}
 
-${data.deprecated ? documentDeprecated(data) : ""}
+${data.deprecated ? documentDeprecated(data) : ''}
 
-${data.params ? documentParams(data) : ""}
+${data.params ? documentParams(data) : ''}
 
-${data.returns ? documentReturn(data) : ""}
+${data.returns ? documentReturn(data) : ''}
 `;
 }
 
@@ -106,18 +88,18 @@ function documentDeprecated(data) {
 
 function documentParams(data) {
   const params = data.params.map(
-    (param) => `- \`${param.name}\` (\`${param.type.names.join("|")}\`)
+    (param) => `- \`${param.name}\` (\`${param.type.names.join('|')}\`)
 ${param.description}
-`
+`,
   );
   return `### Parameters
-${params.join("\n")}
+${params.join('\n')}
 `;
 }
 
 function documentReturn(data) {
   return `### Return Value
-- (\`${data.returns[0].type.names.join("|")}\`)
+- (\`${data.returns[0].type.names.join('|')}\`)
 ${data.returns[0].description}
 `;
 }
@@ -135,4 +117,3 @@ for (const file of publicClassFiles) {
 for (const file of publicTypedefFiles) {
   generateTypedefMarkdown(file);
 }
-