@albalyu/npm-scripts

OpusCapita npm scripts

Synopsis

Package provides an unified release/build approach for npm package and grails plugin from npm packages.

Usage

Npm goals

• npm-publish - build and publish npm module to local repository

  --test - generate npm package and save as local file (tarball will be created instead of publishing to NPM)

  --release - create release, publish the package to local repo with calling update-changelog goal

• update-changelog - update CHANGELOG.md with changes between releases

  --all - completely regenerate CHANGELOG.md with all changes between all releases

• grails-plugin-install - package and install grails plugin to local repository

  --release - install plugin as release

• grails-plugin-deploy - package and install grails plugin to remote repository

  --release - deploy plugin as release

• grails-plugin-package - package grails plugin

  --release - package plugin as release

• grails3-plugin-install - package and install grails 3 plugin to local repository

  --release - install plugin as release

• grails3-plugin-deploy - package and install grails 3 plugin to remote repository

  --release - deploy plugin as release

• grails3-plugin-package - package grails 3 plugin

  --release - package plugin as release

NPM publish example

package.json

...
"scripts": {
  "npm-build": "rimraf ./lib && webpack --config ./webpack.production.config",
  "npm-publish": "npm run npm-build && npm-publish",
  "publish-release": "npm run npm-publish -- --release",
  "publish-snapshot": "npm run npm-publish"
}
...

Grails plugin configuration

If you want publish module as grails resources, you can add grails section in your package.json

package.json

...
"grails": {
  "artefactId": "simple-js-resources",
  "groupId":"com.opuscapita.grailsplugins",
  "resources": {
    "external-resources": {
      "dependsOn": ["jquery"],
      "defaultBundle": false,
      "files": {
        "bundles/first.js": "js/bundles/first.js",
        "bundles/second.js": "js/bundles/second.js"
      }
    }
  },
  "standaloneFiles": {
    "bundles/first.js": "src/java/first.js",
    "bundles/second.js": "src/java/second.js",
    "resources/fonts": "web-app/fonts"
  }
}
...

• artefactId - override artefact ID for grails plugins, by default will be taken from project.name
• groupId - override group ID for grails plugins, by default will be com.opuscapita.grailsplugins
• resources - override artefact ID for grails plugins, by default will be taken from project.name
  • external-resources - grails resource ID
    • dependsOn - list of grails resource module IDs (not required)
    • defaultBundle - string or boolean, defines grails resource module defaultBundle value (not required)
    • files - copy files relative web-app dir
• standaloneFiles - copy files relative root dir

To be able to deploy grails plugins you must to have Maven v3.x to be installed and mvn (or mvn.cmd under Windows) available in PATH.

Contributors

• Dmitry Divin [e-mail]
• Alexey Sergeev [e-mail]

License

OpusCapita npm-scripts is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.