package.cjs.configs.scripts.jsdoc-builder.index.mjs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neeto-commons-frontend Show documentation

A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.

There is a newer version: 4.12.3

Show newest version

import fs from "fs";
import path from "path";

import _generate from "@babel/generator";
import _traverse from "@babel/traverse";
import * as babelTypes from "@babel/types";

import {
  DOCS_FOLDER_NAME,
  EXPORTED_TYPES_FOLDER_NAME,
  TYPES_FOLDER_NAME,
} from "./constants.mjs";
import {
  buildEntityTitleToEntityDescMap,
  getFileContent,
  getFileNameList,
  parseMarkdown,
  parseTypeFile,
  syncTypeFiles,
  defaultTypeFileTraverser,
} from "./utils.mjs";

const traverse = _traverse.default;
const generate = _generate.default;

const buildJsdoc = ({
  customTypeFileTraverser = defaultTypeFileTraverser,
  exportedTypesFolderName = EXPORTED_TYPES_FOLDER_NAME,
} = {}) => {
  const fileNamesInsideDocs = getFileNameList(path.resolve(DOCS_FOLDER_NAME));
  const typeFileNames = fs.readdirSync(path.resolve(TYPES_FOLDER_NAME));

  syncTypeFiles(exportedTypesFolderName);

  const entityTitleToDescMapOfAllFiles = {};

  fileNamesInsideDocs.forEach(docFileName => {
    const fileContent = getFileContent(docFileName);
    const markdownAST = parseMarkdown(fileContent);

    buildEntityTitleToEntityDescMap(
      markdownAST.children,
      entityTitleToDescMapOfAllFiles
    );
  });

  // eslint-disable-next-line consistent-return
  typeFileNames.forEach(typeFileName => {
    const typeFileContent = getFileContent(
      path.join(exportedTypesFolderName, typeFileName)
    );
    const typeFileAST = parseTypeFile(typeFileContent);

    customTypeFileTraverser({
      typeFileName: `${exportedTypesFolderName}/${typeFileName}`,
      typeFileAST,
      entityTitleToDescMapOfAllFiles,
      babelTraverse: traverse,
      babelCodeGenerator: generate,
      babelTypes,
    });
  });

  console.log("Successfully added JSDoc comments to type files.");
};

export default buildJsdoc;