GoGoCode Documentation

GoGoCode is an AST-based code transformation tool for JavaScript, TypeScript, HTML, and Vue. It is designed to automate tasks such as framework upgrades, code refactoring, and multi-platform conversions.

Key features include:

• Intuitive API: Uses a jQuery-like API for AST traversal and a regex-like syntax for matching and replacing code segments.
• Proven Reliability: Used for large-scale migrations (e.g., 100k+ lines of code at Alibaba) and powers the Vue 2 to Vue 3 migration solution.
• Extensible Ecosystem: Supports a plugin and CLI mechanism for building complex CodMods.

GoGoCode is an AST-based code transformation tool for JavaScript, TypeScript, and HTML. It provides an intuitive API designed for developers to find and modify code structures using two primary mechanisms:

1. jQuery-like API: Used for traversing and manipulating the Abstract Syntax Tree (AST).
2. Regex-like Syntax: A syntax similar to regular expressions used to match and replace specific code patterns.

You can experiment with these transformations in the GoGoCode Playground.

GoGoCode is an AST-based transformer for JavaScript, TypeScript, and HTML. It provides an intuitive API for code manipulation using two primary concepts:

• jQuery-like API: Used to select and transform specific AST (Abstract Syntax Tree) elements.
• Regex-like syntax: Used to match and replace code patterns within the AST.

It is designed to allow developers to perform complex code refactoring and transformations with a syntax that feels familiar to string manipulation but operates safely on the code structure.

You can use gogocode-plugin-vue to automatically update version numbers for vue and vue-cli within your package.json file.

gogocode -s ./package.json -t gogocode-plugin-vue -o ./package.json

To install the necessary dependencies for the sub-app1 project, run the following command in the project root.

npm install

Install the plugin as a development dependency using npm:

npm install esbuild-dynamic-import-plugin --save-dev

You can use gogocode-plugin-optional-chaining as a custom transformation plugin by creating a transform.js file in your project root and calling it via the gogocode-cli.

When the plugin is executed, it receives three arguments:

• fileInfo: An object containing source (the file content) and path (the file path).
• api: An object containing the gogocode transformation library.
• options: The options passed from the command line.

To implement the plugin, export a function that uses api.gogocode to manipulate the source code and returns the transformed string using .generate().

module.exports = function(fileInfo, api, options) {
  const sourceCode = fileInfo.source;
  const $ = api.gogocode;
  return $(sourceCode)
    .replace('const a = $_$', 'const a = 2')
    .generate();
};

To ensure consistent formatting and make code diffs easier to read after AST transformations, format your source code using the gogocode-plugin-prettier before or after transformations.

gogocode -s ./src -t gogocode-plugin-prettier  -o ./src

Use the init command to scaffold a sample project for developing new GoGoCode plugins.

gogocode init

You can control which transformation rules are applied using the -p flag with include-rules or exclude-rules.

• Include specific rules: Use -p include-rules=rule1,rule2 to apply only the specified rules.
• Exclude specific rules: Use -p exclude-rules=rule1,rule2 to skip the specified rules.

Rule names can be found in the name field of the plugin's src/rules.js file.

Install the gogocode package via npm to use its AST processing capabilities.

npm install gogocode

To compile the project and enable hot-reloading for development, use the serve script.

npm run serve