Skip to content

Commit

Permalink
✨ Publish gitmojis as an npm package (#444)
Browse files Browse the repository at this point in the history
* 🔧 Add gitmojis.json as main and files on package.json
* 🔧 Update name and private attributes
* 🔧 Move dependencies to devDependencies
* 🔧 Add prepublish script
* 🔧 Add more fields to package.json
* 📝 Write docs about the dependency
* 🔧 Validate gitmojis as a pipeline step
  • Loading branch information
carloscuesta authored Jun 3, 2020
1 parent 8d13270 commit e9eed72
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ script:
- yarn run lint
- yarn run flow
- yarn run test
- yarn run validate:gitmojis
before_deploy:
- yarn run build
- yarn run export
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

**Using emojis** on **commit messages** provides an **easy way** of **identifying the purpose or intention of a commit** with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.

The gitmojis are published on the [following package](https://www.npmjs.com/package/gitmoji) in order to be used as a dependency 📦.

## Using [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli)

To use gitmojis from your command line install [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli). A gitmoji interactive client for using emojis on commit messages.
Expand All @@ -30,7 +32,7 @@ npm i -g gitmoji-cli

## Related tools

- [gitmoji-changelog](https://github.com/frinyvonnick/gitmoji-changelog/): A changelog generator for gitmoji 😜 It uses emojis in your commit messages to group them and create a markdown file with your changes.
- [`gitmoji-changelog.](https://github.com/frinyvonnick/gitmoji-changelog/): A changelog generator for gitmoji.

## Contributing to gitmoji

Expand Down
31 changes: 24 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"name": "gitmoji",
"name": "gitmojis",
"version": "1.0.0",
"private": true,
"description": "An emoji guide for your commit messages.",
"private": false,
"main": "src/data/gitmojis.json",
"files": ["src/data/gitmojis.json"],
"scripts": {
"build": "next build",
"dev": "next dev",
Expand All @@ -10,19 +13,18 @@
"lint": "prettier --check src/**/*.{js,json,scss}",
"start": "next start",
"test": "jest --coverage",
"validate:gitmojis": "jsonlint ./src/data/gitmojis.json -V ./src/data/schema.json"
"validate:gitmojis": "jsonlint ./src/data/gitmojis.json -V ./src/data/schema.json",
"prepublishOnly": "git checkout master && git pull && npm run validate:gitmojis"
},
"dependencies": {
"devDependencies": {
"@babel/preset-flow": "^7.0.0",
"@zeit/next-sass": "^1.0.1",
"clipboard": "^2.0.4",
"next": "9.1.1",
"node-sass": "^4.13.0",
"react": "16.11.0",
"react-dom": "16.11.0",
"react-test-renderer": "^16.11.0"
},
"devDependencies": {
"react-test-renderer": "^16.11.0",
"flow-bin": "^0.110.1",
"husky": "^3.0.9",
"identity-obj-proxy": "^3.0.0",
Expand All @@ -32,6 +34,21 @@
"optimize-css-assets-webpack-plugin": "^5.0.3",
"prettier": "1.18.2"
},
"author": "Carlos Cuesta",
"license": "MIT",
"bugs": {
"url": "https://github.com/carloscuesta/gitmoji-cli/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/carloscuesta/gitmoji-cli.git"
},
"keywords": [
"gitmoji",
"emoji",
"carloscuesta",
"commit"
],
"prettier": {
"semi": false,
"singleQuote": true,
Expand Down

0 comments on commit e9eed72

Please sign in to comment.