开源项目 `file-icons/atom` 使用教程

开源项目 file-icons/atom 使用教程

atomAtom file-specific icons for improved visual grepping.项目地址:https://gitcode.com/gh_mirrors/ato/atom

1. 项目的目录结构及介绍

file-icons/atom/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── keymaps/
│   └── file-icons.cson
├── lib/
│   ├── icons/
│   │   ├── all.js
│   │   ├── custom.js
│   │   ├── extensions.js
│   │   ├── languages.js
│   │   ├── patterns.js
│   │   └── scopes.js
│   ├── index.js
│   ├── main.js
│   ├── service.js
│   └── utils.js
├── menus/
│   └── file-icons.cson
├── package.json
├── spec/
│   ├── main-spec.js
│   ├── service-spec.js
│   └── utils-spec.js
└── styles/
    └── file-icons.less

• CHANGELOG.md: 记录项目的更新日志。
• CONTRIBUTING.md: 指导如何为项目贡献代码。
• LICENSE.md: 项目的许可证信息。
• README.md: 项目的介绍和使用说明。
• keymaps/: 包含快捷键配置文件。
• lib/: 包含项目的主要代码文件。
  • icons/: 包含各种图标的定义文件。
  • index.js: 项目的入口文件。
  • main.js: 主逻辑文件。
  • service.js: 服务相关的代码。
  • utils.js: 工具函数。
• menus/: 包含菜单配置文件。
• package.json: 项目的元数据和依赖信息。
• spec/: 包含测试文件。
• styles/: 包含样式文件。

2. 项目的启动文件介绍

项目的启动文件是 lib/index.js。这个文件是项目的入口点，负责初始化插件并加载其他必要的模块。

// lib/index.js
module.exports = {
  activate: require("./main").activate,
  deactivate: require("./main").deactivate,
  provide: require("./service").provide
};

• activate: 激活插件时调用的函数。
• deactivate: 停用插件时调用的函数。
• provide: 提供服务时调用的函数。

3. 项目的配置文件介绍

项目的配置文件主要有两个：package.json 和 keymaps/file-icons.cson。

package.json

package.json 文件包含了项目的元数据和依赖信息。

{
  "name": "file-icons",
  "main": "./lib/index",
  "version": "2.1.47",
  "description": "Assign file extension icons and colours for improved visual grepping",
  "keywords": [
    "file-icons",
    "file icons"
  ],
  "repository": "https://github.com/file-icons/atom",
  "license": "MIT",
  "engines": {
    "atom": ">=1.0.0 <2.0.0"
  },
  "dependencies": {
    "atom-package-deps": "^7.0.0",
    "etch": "^0.14.1",
    "fast-glob": "^3.2.4",
    "fs-plus": "^3.1.1",
    "iconv-lite": "^0.6.2",
    "js-yaml": "^4.0.0",
    "lodash": "^4.17.20",
    "minimatch": "^3.0.4",
    "resolve": "^1.19.0",
    "semver": "^7.3.2",
    "temp": "^0.9.0",
    "uuid": "^8.3.1"
  },
  "package-deps": [
    "tree-view"
  ],
  "devDependencies": {
    "eslint": "^7.12.1",
    "eslint-config-airbnb-base": "^14.2.0",
    "eslint-plugin-import": "^2.22.1"
  }
}

atomAtom file-specific icons for improved visual grepping.项目地址:https://gitcode.com/gh_mirrors/ato/atom