npm 包 common-js-file-extensions 使用教程

在前端开发中，我们经常需要使用不同类型的文件，比如 JS、CSS、HTML、图片等等。而这些文件的扩展名也千奇百怪，特别是在模块化开发中，我们需要使用一些特殊的文件类型，比如 .jsx、.scss 等等。在 Node.js 中，有一个常用的模块 path 可以解析文件路径，但是它并不能识别所有的文件类型，这就需要我们借助 common-js-file-extensions 这个 npm 包来实现。

安装

在使用 common-js-file-extensions 之前，我们需要先安装它。在终端中输入以下命令：

npm install common-js-file-extensions --save

使用

引入模块

在 Node.js 中，使用 require 函数来引入模块。

var cjs = require('common-js-file-extensions');

获取文件类型

通过 cjs 变量可以获取 common-js-file-extensions 中预定义的文件类型。

JavaScript 类型

console.log(cjs.js); // .js
console.log(cjs.jsx); // .jsx
console.log(cjs.es6); // .es6
console.log(cjs.cjs); // .cjs
console.log(cjs.mjs); // .mjs

CSS 类型

console.log(cjs.css); // .css
console.log(cjs.scss); // .scss
console.log(cjs.less); // .less
console.log(cjs.postcss); // .pcss

HTML 类型

console.log(cjs.html); // .html
console.log(cjs.htm); // .htm
console.log(cjs.xhtml); // .xhtml

其他类型

console.log(cjs.json); // .json
console.log(cjs.yaml); // .yaml
console.log(cjs.xml); // .xml
console.log(cjs.csv); // .csv

判断文件类型

使用 extname 方法可以获取文件的扩展名。

var path = require('path');
var file = 'index.jsx';
var extname = path.extname(file);
console.log(extname); // .jsx

使用 common-js-file-extensions 可以判断文件是否为特定类型：

var cjs = require('common-js-file-extensions');
var path = require('path');
var file = 'index.jsx';
var extname = path.extname(file);
console.log(cjs.isJS(extname)); // true
console.log(cjs.isCSS(extname)); // false
console.log(cjs.isHTML(extname)); // false

拓展新类型

在某些情况下，预定义的文件类型可能不能满足我们的需求，我们可以通过 set 方法添加新的文件类型。

var cjs = require('common-js-file-extensions');
cjs.set('Markdown', '.md');
console.log(cjs.Markdown); // .md

示例代码

下面是一个完整的示例代码，演示如何使用 common-js-file-extensions。

-- -------------------- ---- -------
--- --- - -------------------------------------
--- ---- - ----------------

-- -------
--- ---- - ------------
--- ------- - -------------------

-- ------- --
------------------------------- -- ----

-- ------- ---
-------------------------------- -- -----

-- ------- ----
--------------------------------- -- -----

-- -----
------------------- -------
-------------------------- -- ---
展开代码

总结

common-js-file-extensions 是一个非常实用的 npm 包，它可以帮助我们更方便地处理文件类型，特别是在模块化开发中，能够大大提高开发效率。学习使用这个 npm 包，也能够帮助我们更深入地了解 Node.js 中的模块化开发机制。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/77233