build(publish-npm): prepare the NPM registry publishing

Polish the documentations. Add some docs files in the package.
Also cleanup some unneeded files

Author: Clément PREVOT

CONTRIBUTING.md

@@ -1,6 +1,20 @@
 # Contributing to LumX
 
-We'd love for you to contribute to our source code and to make it even better than it is today! Here are the guidelines we'd like you to follow:
+We'd love for you to contribute to our source code and to make it even better than it is today!
+
+## Getting the source code
+
+To be able to contribute, you will have to use the global LumX package from our [GitHub repository](https://github.com/lumapps/design-system). You won't be able to contribute from the distributed packages `@lumx/<angularjs/react>`, so be sure to clone the repository before starting contributing:
+
+```bash
+git clone [email protected]:lumapps/design-system.git
+# Or with HTTPS
+git clone https://github.com/lumapps/design-system.git
+```
+
+# Table of contents
+
+Here are the guidelines we'd like you to follow.
 
 -   [Code of Conduct](#code-of-conduct)
 -   [Got a question or a problem?](#got-a-question-or-a-problem-)

LICENCE.md renamed to LICENSE.md

@@ -18,8 +18,7 @@ npm install @lumx/<angularjs|react>
 -   Download the latest release for [AngularJS][angularjs-release] or [ReactJS][reactjs-release]
 -   Clone the repository: `git clone https://github.com/lumapps/design-system.git`
 
-You can then use the UMD, AMD or CommonJS bundle that suits your taste.
-See [examples](./dist/examples) for more information on how to use each bundle.
+See [examples](./dist/<angularjs|react>/examples) for more information on how to use each bundle.
 
 ## Documentation
 
@@ -33,7 +32,7 @@ Please refer to our [contributing guidelines](CONTRIBUTING.md).
 ## Project installation
 
 [Yarn dependency manager](https://yarnpkg.com/) is recommended to launch the project. Check out the [official installation documentation](https://yarnpkg.com/en/docs/install) if not installed.
-You will need Yarn to execute the automatic setup script.
+You will need Yarn to execute the automatic setup script as well as for publishing the package.
 
 ### Install project dependencies
 
@@ -80,20 +79,42 @@ You can then open your browser to [http://localhost:4001/](http://localhost:4001
 you can build LumX by using:
 
 ```bash
-yarn build[:<all|react[:<commonjs>]|angularjs]
+yarn build[:<all|angularjs|react]
 # Or
-npm run build:<react:commonjs|angularjs>
+npm run build:<all|angularjs|react>
 ```
 
 This will produce the target build for either AngularJS or ReactJS.
 
+## How to run examples
+
+In the `dist/<angularjs|react>` directory, run:
+
+```bash
+yarn install
+# Or
+npm install
+```
+
+This will install `http-server`, a simple HTTP server.
+
+Then run:
+
+```bash
+yarn serve
+# Or
+npm run serve
+```
+
+Your browser should open automatically, otherwise, you can go to [http://localhost:8080](http://localhost:8080) for AngularJS example or [http://localhost:8081](http://localhost:8081) for ReactJS example.
+Then, click on the `examples` directory in the showing listing and you should land on the example page.
+
 ## Copyright and license
 
 Code and documentation copyright 2019 LumApps. Code released under the [MIT license](LICENSE.md).
 
 [angularjs]: https://angularjs.org/
 [reactjs]: https://reactjs.org/
-[local]: http://localhost:8888
 [material]: http://www.google.com/design/spec/material-design/introduction.html
 [angularjs-release]: https://www.npmjs.com/package/@lumx/angularjs
 [reactjs-release]: https://www.npmjs.com/package/@lumx/react

README.md

@@ -65,6 +65,7 @@
         "babel-plugin-smart-webpack-import": "^1.4.2",
         "commitizen": "^3.0.7",
         "copy-webpack-plugin": "^5.0.0",
+        "create-file-webpack": "^1.0.2",
         "css-loader": "^2.1.0",
         "enzyme": "^3.9.0",
         "enzyme-adapter-react-16": "^1.10.0",
@@ -153,10 +154,8 @@
         "ReactJS"
     ],
     "license": "MIT",
-    "main": "dist/index.js",
-    "module": "dist/lumx.esm.js",
     "name": "@lumx/lumx",
-    "private": false,
+    "private": true,
     "repository": {
         "type": "git",
         "url": "git+https://github.com/lumapps/design-system.git"
@@ -166,6 +165,12 @@
         "build:all": "rm -Rf ./dist/ && npm -s run build:angularjs; npm -s run build:react",
         "build:angularjs": "rm -Rf ./dist/angularjs && webpack --config webpack/angularjs/webpack.umd.js",
         "build:react": "rm -Rf ./dist/react && webpack --config webpack/react/webpack.umd.js",
+        "prebump:major": "cd src/icons && npm --no-git-tag-version version major && git add package.json && cd -",
+        "bump:major": "npm version --force --message 'chore(release): release new major version %s' major",
+        "prebump:minor": "cd src/icons && npm --no-git-tag-version version minor && git add package.json && cd -",
+        "bump:minor": "npm version --force --message 'chore(release): release new minor version %s' minor",
+        "prebump:patch": "cd src/icons && npm --no-git-tag-version version patch && git add package.json && cd -",
+        "bump:patch": "npm version --force --message 'chore(release): release new patch version %s' patch",
         "commit": "git-cz",
         "co": "npm -s run commit",
         "cz": "npm -s run commit",

examples/README.md

@@ -1,19 +1,19 @@
 const merge = require('webpack-merge');
 
 const { buildConfig } = require('../utils');
-const { MINIFY } = require('../constants');
+const { MINIFY: minify } = require('../constants');
 
 const angularJSConfig = require('./webpack.config');
 
 const UMDConfig = {};
 
-module.exports = buildConfig(
-    merge.smartStrategy({
+module.exports = buildConfig({
+    config: merge.smartStrategy({
         entry: 'append',
         'module.rules': 'append',
         plugins: 'replace',
     })(angularJSConfig, UMDConfig),
-    'angularjs',
-    'umd',
-    MINIFY,
-);
+    tech: 'angularjs',
+    moduleType: 'umd',
+    minify,
+});

examples/package.json

@@ -1,14 +1,28 @@
-const { getAbsolutePath } = require('./common-utils');
+const path = require('path');
+
+/**
+ * Gives an absolute path by resolving the provided relative path.
+ *
+ * @param  {string} pathName The relative path.
+ * @return {string} The resolved absolute path.
+ */
+function getAbsolutePath(pathName) {
+    return path.resolve(__dirname, pathName);
+}
 
 // Path relative constants.
 const ROOT_PATH = getAbsolutePath('../');
+
+const DEMO_PATH = `${ROOT_PATH}/demo`;
+const DIST_PATH = `${ROOT_PATH}/dist`;
+const EXAMPLES_PATH = `${ROOT_PATH}/examples`;
 const NODE_MODULES_PATH = `${ROOT_PATH}/node_modules`;
-const SRC_PATH = getAbsolutePath('../src');
+const SRC_PATH = `${ROOT_PATH}/src`;
+
 const COMPONENTS_PATH = `${SRC_PATH}/components`;
 const CORE_PATH = `${SRC_PATH}/core`;
-const DEMO_PATH = getAbsolutePath('../demo');
-const EXAMPLES_PATH = getAbsolutePath('../examples');
 const ICONS_PATH = `${SRC_PATH}/icons`;
+
 const STYLES_PATH = `${CORE_PATH}/style`;
 
 // Indicates if we want to minify the production bundle.
@@ -19,6 +33,16 @@ const TECH_PREFIX = {
     angularjs: 'angularjs',
     react: 'react',
 };
+const TECH_DESCRIPTIONS = {
+    angularjs: 'The official LumApps Design System (LumX) for AngularJS applications',
+    default: 'The official LumApps Design System (LumX)',
+    react: 'The official LumApps Design System (LumX) for ReactJS applications',
+};
+const TECH_KEYWORDS = {
+    angularjs: ['AngularJS'],
+    default: ['Design System', 'LumApps', 'LumX'],
+    react: ['ReactJS'],
+};
 
 // Dev-server relative constants
 const DEFAULT_HOST = '0.0.0.0';
@@ -189,12 +213,15 @@ module.exports = {
     DEFAULT_HOST,
     DEFAULT_PORT,
     DEMO_PATH,
+    DIST_PATH,
     EXAMPLES_PATH,
     ICONS_PATH,
     MINIFY,
     NODE_MODULES_PATH,
     ROOT_PATH,
     SRC_PATH,
     STYLES_PATH,
+    TECH_DESCRIPTIONS,
+    TECH_KEYWORDS,
     TECH_PREFIX,
 };

package.json

@@ -1,19 +1,19 @@
 const merge = require('webpack-merge');
 
 const { buildConfig } = require('../utils');
-const { MINIFY } = require('../constants');
+const { MINIFY: minify } = require('../constants');
 
 const reactConfig = require('./webpack.config');
 
 const UMDConfig = {};
 
-module.exports = buildConfig(
-    merge.smartStrategy({
+module.exports = buildConfig({
+    config: merge.smartStrategy({
         entry: 'append',
         'module.rules': 'append',
         plugins: 'replace',
     })(reactConfig, UMDConfig),
-    'react',
-    'umd',
-    MINIFY,
-);
+    tech: 'react',
+    moduleType: 'umd',
+    minify,
+});