Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 1.67 KB

README.md

File metadata and controls

61 lines (45 loc) · 1.67 KB

@gasket/plugin-git

This a built-in plugin to the Gasket CLI used to set up new apps with git repositories when using the gasket create command.

Usage

The features of this plugin hooks are in the lifecycles it hooks during the create process.

prompt

The prompt will ask users during the create command if they wish to initialize a git repo or not. This prompt will set the gitInit property of the create context. It is possible to default this in a preset, by setting this in the preset's package.json, under a gasket.create property.

In the following example, when a new app is created with this preset, a git repo will always be initialized, and the user not prompted.

{
  "name": "gasket-preset-example",
  "version": "1.2.3",
  "main": "index.js",
  "dependencies": {
    "@gasket/resolve": "^2.0.0",
    "gasket-plugin-example": "^1.0.0"
  },
  "gasket": {
    "create" : {
      "gitInit": true
    }
  }
}

create

During the create lifecycle, .gitignore and .gitattributes templates will be registered to be generated for the app.

postCreate

After all the app contents are generated, this plugin's postCreate hook will make a first commit for the generated files. The timing for this hook is set to run last. It is important when creating plugins that implement postCreate hooks, that their timings do come after the Git plugin, especially if modifying files, otherwise those modifications will not be part of the first commit.

See plugin hook timings for more information.

License

MIT