JavaScript Externs Generator 使用教程

JavaScript Externs Generator 使用教程

javascript-externs-generatorGenerate externs for use with Google Closure Compiler项目地址:https://gitcode.com/gh_mirrors/ja/javascript-externs-generator

项目介绍

javascript-externs-generator 是一个方便的工具，专为配合 Google Closure Compiler 设计，帮助开发者自动生成对象的属性、方法和原型描述文件（extern 文件）。这个工具的目标是避免在高级编译过程中误删或重命名外部变量，确保你的代码与依赖库能无缝对接。

项目快速启动

安装

首先，你需要安装 Node.js 和 npm。然后，通过以下命令安装 javascript-externs-generator：

npm install javascript-externs-generator -g

生成 Externs 文件

假设你有一个 JavaScript 文件 example.js，你可以通过以下命令生成 externs 文件：

javascript-externs-generator example.js -o example.externs.js

使用生成的 Externs 文件

将生成的 example.externs.js 文件与 Google Closure Compiler 一起使用：

java -jar closure-compiler.jar --compilation_level ADVANCED_OPTIMIZATIONS --externs example.externs.js --js example.js --js_output_file compiled.js

应用案例和最佳实践

案例一：React 项目

假设你正在开发一个使用 React 的项目，你可以为 React 和 ReactDOM 生成 externs 文件：

javascript-externs-generator node_modules/react/umd/react.production.min.js -o react.externs.js
javascript-externs-generator node_modules/react-dom/umd/react-dom.production.min.js -o react-dom.externs.js

然后在 Closure Compiler 中使用这些 externs 文件：

java -jar closure-compiler.jar --compilation_level ADVANCED_OPTIMIZATIONS --externs react.externs.js --externs react-dom.externs.js --js your-app.js --js_output_file compiled-app.js

最佳实践

1. 自动化生成：将 externs 文件的生成集成到构建流程中，确保每次依赖更新时都能自动生成新的 externs 文件。
2. 手动调整：对于某些特殊库，可能需要手动调整生成的 externs 文件，以确保准确性。

典型生态项目

Google Closure Compiler

javascript-externs-generator 主要用于配合 Google Closure Compiler 进行高级编译优化。Closure Compiler 是一个强大的工具，可以显著减小 JavaScript 文件的大小并提高性能。

shadow-cljs

shadow-cljs 是一个用于 ClojureScript 的构建工具，它也提供了 externs 文件的生成功能。如果你使用 ClojureScript，可以考虑使用 shadow-cljs 来管理 externs 文件。

Externs Inference

David Nolen 的工作 "Externs Inference" 提供了一种自动推断 externs 文件的方法，可以作为 javascript-externs-generator 的替代方案。

通过以上内容，你应该能够快速上手并使用 javascript-externs-generator 来优化你的 JavaScript 项目。

javascript-externs-generatorGenerate externs for use with Google Closure Compiler项目地址:https://gitcode.com/gh_mirrors/ja/javascript-externs-generator