Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: mdx doc generation scripts #1862

Merged
merged 2 commits into from
Sep 19, 2024
Merged

refactor: mdx doc generation scripts #1862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
406bb88
refactor: mdx doc generation scripts
abose Sep 19, 2024
a6b2304
refactor: add build/temp to gitignore
abose Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ test/thirdparty/jasmine-reporters
/src/styles/brackets.min.css.map
/src/assets/default-project/*.zip
/src/assets/sample-projects/*.zip
/build/temp


# ignore everything in the dev extension directory EXCEPT the README
Expand Down
180 changes: 59 additions & 121 deletions build/api-docs-generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,23 @@
const { execSync } = require('child_process');

// Define the input and output directories
const inputDir = path.join(__dirname, '../src');
const BUILD_DIR = __dirname;
const ROOT_DIR = path.join(BUILD_DIR, '../');
const SRC_DIR = path.join(ROOT_DIR, 'src');

// DONOT MODIFY THIS
const outputDir = path.join(__dirname, './dev-temp'); // this directory will be automatically removed (required for automative processes, the final output will be in API directory).
// this directory will be automatically removed (required for automative processes, the final output will
// be in API directory).
const outputDir = path.join(BUILD_DIR, './dev-temp');

// Set up paths for the build process
const buildDir = __dirname;
const jsdocFile = path.join(buildDir, 'jsdoc.json');
const configFile = path.join(buildDir, 'config.json');
const sourceDir = path.join(buildDir, 'dev-temp');
const devApiDir = path.join(buildDir, 'dev-api');
const GENERATED_DOCS_FOLDER = path.join(SRC_DIR, '../', 'docs', 'Generated API Reference');
const JSDOC_FILE = path.join(BUILD_DIR, 'jsdoc.json');
const CONFIG_FILE = path.join(BUILD_DIR, 'config.json');
const MDX_API_DIR = path.join(BUILD_DIR, 'api');
const sourceDir = path.join(BUILD_DIR, 'dev-temp');
const devApiDir = path.join(BUILD_DIR, 'dev-api');
const tempDir = path.join(devApiDir, 'temp');
const mdxApiDir = path.join(__dirname, 'api');


/**
Expand Down Expand Up @@ -164,7 +168,7 @@
});
}

processFilesRecursively(inputDir, inputDir);
processFilesRecursively(SRC_DIR, SRC_DIR);
console.log("All script files for the API documentation have been generated!");

removeEmptyDirectories(outputDir);
Expand All @@ -177,6 +181,29 @@

// Conversion of MDX from JS files starts here

const JSDOC_JSON_TEMPLATE = {
"source": {
"include": [
"dev-api\\temp"
]
},
"plugins": [
"plugins/markdown"
],
"opts": {
"destination": "../api",
"recurse": true
}
};

const CONFIG_JSON_TEMPLATE = {
"locales": [
"en"
],
"outDir": "",
"jsdoc": "./jsdoc.json",
"bulma": false
};

/**
* Generates MDX files from JS files using jsdoc-to-mdx.
Expand All @@ -187,19 +214,19 @@
// Create necessary directories (all these directories will be removed automatically
// after the task is completed. Finally after the whole execution we'll be left with
// just the API directory i.e. mdxApiDir)
[devApiDir, tempDir, mdxApiDir].forEach(dir => {
[devApiDir, tempDir, MDX_API_DIR].forEach(dir => {
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
}
});

// Read JSDoc and config files
let jsdocConfig = readJsdocFile();
let config = readConfigFile();
let jsdocConfig = JSDOC_JSON_TEMPLATE;
let config = CONFIG_JSON_TEMPLATE;

// Modify JSDoc config to use temp directory
jsdocConfig.source.include = [path.relative(buildDir, tempDir)];
fs.writeFileSync(jsdocFile, JSON.stringify(jsdocConfig, null, 2));
jsdocConfig.source.include = [path.relative(BUILD_DIR, tempDir)];
fs.writeFileSync(JSDOC_FILE, JSON.stringify(jsdocConfig, null, 2));

// Copy JS files to dev-api directory
copyJsFiles(sourceDir, devApiDir);
Expand All @@ -212,10 +239,10 @@

// After processing all files, set outDir to empty string
config.outDir = "";
fs.writeFileSync(configFile, JSON.stringify(config, null, 2));
fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));

// Post-processing of MDX files
processMdxFiles(mdxApiDir);
processMdxFiles(MDX_API_DIR);

// Clean up temporary files and directories
cleanupTempFiles();
Expand All @@ -226,30 +253,6 @@
}
}

/**
* Reads JSDoc configuration file.
* @returns {Object} JSDoc configuration object
*/
function readJsdocFile() {
if (fs.existsSync(jsdocFile)) {
return JSON.parse(fs.readFileSync(jsdocFile, 'utf-8'));
}
console.error("Jsdoc.json not found! Make sure it is inside the same directory as of the script!");

}

/**
* Reads the configuration file.
* @returns {Object} Configuration object
*/
function readConfigFile() {
if (fs.existsSync(configFile)) {
return JSON.parse(fs.readFileSync(configFile, 'utf-8'));
}
console.error("Config.json not found! Make sure it is inside the same directory as of the script!");

}

/**
* Copies JS files from source to destination directory.
*
Expand Down Expand Up @@ -312,17 +315,17 @@
fs.copyFileSync(file, path.join(tempDir, path.basename(file)));

// Set unique outDir for this file
const outDir = path.join(mdxApiDir, relativeDir, fileName);
config.outDir = path.relative(__dirname, outDir);
fs.writeFileSync(configFile, JSON.stringify(config, null, 2));
const outDir = path.join(MDX_API_DIR, relativeDir, fileName);
config.outDir = path.relative(BUILD_DIR, outDir);
fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));

// Run jsdoc-to-mdx
execSync(`npx jsdoc-to-mdx -c ${path.relative(__dirname, configFile)}`, { cwd: __dirname });
execSync(`npx jsdoc-to-mdx -c ${path.relative(BUILD_DIR, CONFIG_FILE)}`, { cwd: BUILD_DIR });

Check warning

Code scanning / CodeQL

Shell command built from environment values Medium

This shell command depends on an uncontrolled
absolute path
Loading
.

console.log(`${file} is successfully converted to MDX`);

// Merge generated MDX files
mergeMdxFiles(outDir, `${fileName}.mdx`, path.join(mdxApiDir, relativeDir));
mergeMdxFiles(outDir, `${fileName}.mdx`, path.join(MDX_API_DIR, relativeDir));

// Clean up temp file
fs.unlinkSync(path.join(tempDir, path.basename(file)));
Expand Down Expand Up @@ -498,20 +501,9 @@
* This leaves us with just the API directory
*/
function cleanupTempFiles() {
// Remove temp directory
if (fs.existsSync(tempDir)) {
fs.rmSync(tempDir, { recursive: true, force: true });
}

// Remove dev-api directory
if (fs.existsSync(devApiDir)) {
fs.rmSync(devApiDir, { recursive: true, force: true });
}

// Remove source directory
if (fs.existsSync(sourceDir)) {
fs.rmSync(sourceDir, { recursive: true, force: true });
}
fs.rmSync(tempDir, { recursive: true, force: true });
fs.rmSync(devApiDir, { recursive: true, force: true });
fs.rmSync(sourceDir, { recursive: true, force: true });
}


Expand Down Expand Up @@ -560,65 +552,11 @@
}
}

const apiReferenceDir = path.join(__dirname, 'api', 'API reference');
moveToApiReference(path.join(__dirname, 'api'), apiReferenceDir);
console.log("All MDX files have been moved to the API reference folder");


/**
* Delete the docs/generatedApiDocs directory and all its content, to add the new generated content there
*/
function removeGeneratedApiDocs() {
const generatedApiDocsDir = './docs/generatedApiDocs';
try {
fs.rmSync(generatedApiDocsDir, { recursive: true, force: true });
} catch (err) {
console.error(`Error while deleting the generatedApiDocs directory: ${err}`);
}
}

removeGeneratedApiDocs();


/**
* Move the API reference directory from the 'build' directory to the 'docs' directory
* @param {string} srcDir Takes the input dir address
* @param {string} destDir Takes the output dir address
*/
function moveApiReferenceDir(srcDir, destDir) {

// check if API Reference dir already exists in destination. If yes, remove it
if(fs.existsSync(path.join(destDir, 'API Reference'))) {
fs.rmSync(path.join(destDir, 'API Reference'), { recursive: true, force: true });
}

// add full paths
srcDir = path.join(srcDir, 'API Reference');
destDir = path.join(destDir, 'API Reference');

// Move the directory
try {
fs.renameSync(srcDir, destDir);
} catch (err) {
console.error(`Error while moving the directory from build to docs: ${err}`);
}
}

moveApiReferenceDir(mdxApiDir, './docs');

/**
* Delete the API directory i.e. inside the 'build' directory as all its contents are now moved to docs directory
* @param {string} dirToRemove Path of the api dir
*/
function removeApiDir(dirToRemove) {
try {
fs.rmSync(dirToRemove, { recursive: true, force: true });
} catch (err) {
console.error(`Error while deleting the Api directory present inside build directory: ${err}`);
}
}

removeApiDir(mdxApiDir);


console.log("All set! Just copy the docs directory to the docs site.");
console.log("deleting ", GENERATED_DOCS_FOLDER);
fs.rmSync(GENERATED_DOCS_FOLDER, { recursive: true, force: true });
console.log("moving ", MDX_API_DIR, "to", GENERATED_DOCS_FOLDER);
moveToApiReference(MDX_API_DIR, GENERATED_DOCS_FOLDER);
console.log("All set! Updated docs directory.");
fs.rmSync(MDX_API_DIR, { recursive: true, force: true });
fs.rmSync(CONFIG_FILE, { recursive: true, force: true });
fs.rmSync(JSDOC_FILE, { recursive: true, force: true });
8 changes: 0 additions & 8 deletions build/config.json
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions build/jsdoc.json
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
"serveWithWebCache": "npm run _releaseWebCache && npm run _serveWithWebCacheHelp && http-server ./dist -p 8000 -c-1",
"serveExternal": "http-server . -p 8000 -a 0.0.0.0 --log-ip true -c-1",
"createJSDocs": "gulp createJSDocs && git add docs",
"createMDXDocs": "node build/api-docs-generator.js",
"_translateStrings": "gulp translateStrings",
"_minify": "r.js -o require.min.config.js && echo this is untested see https://stackoverflow.com/questions/14337970/minifying-requirejs-javascript-codebase-to-a-single-file"
},
Expand Down
Loading