Git Control 开源项目教程

Git Control 开源项目教程

atom-git-controlNot maintained :(项目地址:https://gitcode.com/gh_mirrors/at/atom-git-control

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

atom-git-control/
├── lib/
│   ├── git.coffee
│   ├── git-control-view.coffee
│   ├── main.coffee
│   └── utils.coffee
├── menus/
│   └── git-control.cson
├── styles/
│   └── git-control.less
├── keymaps/
│   └── git-control.cson
├── snippets/
│   └── git-control.cson
├── spec/
│   └── git-control-spec.coffee
├── package.json
└── README.md

• lib/：包含项目的核心逻辑文件，如 git.coffee 处理 Git 操作，git-control-view.coffee 处理界面显示，main.coffee 是项目的入口文件，utils.coffee 包含一些工具函数。
• menus/：定义菜单项的配置文件。
• styles/：包含项目的样式文件。
• keymaps/：定义快捷键配置文件。
• snippets/：定义代码片段配置文件。
• spec/：包含测试文件。
• package.json：项目的元数据文件，包含依赖、脚本等信息。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 lib/main.coffee，它负责初始化插件并注册命令。以下是该文件的部分代码：

module.exports =
  activate: (state) ->
    @gitControlView ?= new GitControlView(state.gitControlViewState)
    atom.commands.add 'atom-workspace',
      'git-control:toggle': => @gitControlView.toggle()

• activate 方法在插件激活时调用，初始化 GitControlView 并注册 git-control:toggle 命令。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 menus/git-control.cson。

package.json

{
  "name": "git-control",
  "main": "./lib/main",
  "version": "0.9.0",
  "description": "Provides a GUI interface to manage all commonly used git commands.",
  "keywords": [
    "git-control",
    "git-flow",
    "github",
    "bitbucket",
    "git"
  ],
  "repository": "https://github.com/jacogr/atom-git-control",
  "license": "MIT",
  "engines": {
    "atom": ">=1.0.0 <2.0.0"
  },
  "dependencies": {
    "atom-space-pen-views": "^2.0.0",
    "fs-plus": "^2.0.0",
    "git-promise": "^0.3.0",
    "jquery": "^2.1.4",
    "lodash": "^3.10.1",
    "moment": "^2.10.6",
    "q": "^1.4.1",
    "space-pen": "^5.1.1",
    "underscore-plus": "^1.0.0"
  }
}

• name：项目名称。
• main：入口文件路径。
• version：版本号。
• description：项目描述。
• keywords：关键词。
• repository：代码仓库地址。
• license：许可证。
• engines：支持的 Atom 版本。
• dependencies：项目依赖。

menus/git-control.cson

'context-menu':
  'atom-text-editor': [
    {
      'label': 'Git Control'
      'submenu': [
        {
          'label': 'Toggle'
          'command': 'git-control:toggle'
        }
      ]
    }
  ]

'menu': [
  {
    'label': 'Packages'
    'submenu': [
      {
        'label': 'Git Control'
        'submenu': [
          {
            'label': 'Toggle'
            'command': 'git-control:toggle'
          }
        ]
      }
    ]
  }
]

• context-menu：定义上下文菜单项。
• menu：定义主菜单项。
• label：菜单项的显示文本。
• command：菜单项对应的命令。

atom-git-controlNot maintained :(项目地址:https://gitcode.com/gh_mirrors/at/atom-git-control