首页
/ atom-ternjs 项目教程

atom-ternjs 项目教程

2024-09-28 19:44:40作者:胡易黎Nicole

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

atom-ternjs 项目的目录结构如下:

atom-ternjs/
├── config/
├── keymaps/
├── lib/
├── menus/
├── spec/
├── styles/
├── .editorconfig
├── .eslintrc
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── package-lock.json
└── package.json

目录结构介绍

  • config/: 包含项目的配置文件。
  • keymaps/: 包含项目的快捷键配置文件。
  • lib/: 包含项目的主要代码库。
  • menus/: 包含项目的菜单配置文件。
  • spec/: 包含项目的测试文件。
  • styles/: 包含项目的样式文件。
  • .editorconfig: 编辑器配置文件,用于统一代码风格。
  • .eslintrc: ESLint 配置文件,用于代码检查。
  • .gitignore: Git 忽略文件配置。
  • CHANGELOG.md: 项目更新日志。
  • LICENSE.md: 项目许可证文件。
  • README.md: 项目说明文件。
  • package-lock.json: 锁定依赖包版本的文件。
  • package.json: 项目的 npm 配置文件,包含项目的依赖、脚本等信息。

2. 项目的启动文件介绍

atom-ternjs 项目的启动文件主要是 lib/atom-ternjs.js。这个文件是项目的入口文件,负责初始化插件并启动 Tern 服务器。

启动文件介绍

  • lib/atom-ternjs.js: 这是项目的入口文件,负责初始化插件并启动 Tern 服务器。它包含了插件的主要逻辑,如配置加载、服务器启动、自动补全等功能。

3. 项目的配置文件介绍

atom-ternjs 项目的配置文件主要是 package.json.tern-project

配置文件介绍

  • package.json: 这是 npm 的配置文件,包含了项目的元数据、依赖、脚本等信息。通过这个文件,可以管理项目的依赖包和运行脚本。

    {
      "name": "atom-ternjs",
      "version": "0.20.0",
      "description": "JavaScript code intelligence for atom with tern.js and autocomplete-plus",
      "main": "lib/atom-ternjs.js",
      "scripts": {
        "test": "apm test"
      },
      "repository": "https://github.com/tststs/atom-ternjs",
      "license": "MIT",
      "engines": {
        "atom": ">=1.0.0 <2.0.0"
      },
      "dependencies": {
        "tern": "^0.24.3",
        "atom-package-deps": "^7.0.0"
      },
      "package-deps": [
        "autocomplete-plus"
      ]
    }
    
  • .tern-project: 这是 Tern 服务器的配置文件,用于配置项目的 JavaScript 环境、库、插件等。通过这个文件,可以自定义 Tern 服务器的运行环境。

    {
      "ecmaVersion": 8,
      "libs": [
        "browser"
      ],
      "loadEagerly": [
        "path/to/your/js/**/*.js"
      ],
      "dontLoad": [
        "node_modules/**",
        "path/to/your/js/**/*.js"
      ],
      "plugins": {
        "es_modules": {},
        "node": {},
        "doc_comment": {
          "fullDocs": true,
          "strong": true
        }
      }
    }
    

通过以上配置文件,可以灵活地配置 atom-ternjs 插件,以满足不同的开发需求。

登录后查看全文
热门项目推荐