feat (scripts): add TOC generation and test script

Author: solkimicreb

README.md

@@ -6,15 +6,32 @@ Transparent reactivity without special syntax and with a **100% language observa
 
 [React Easy State](https://github.com/solkimicreb/react-easy-state) is a React state management solution - based on this library. This library is part of the [NX framework](https://nx-framework.com).
 
-## Table of contents
-
-- [Installation](#installation)  
-- [Usage](#usage)
-- [Features](#key-features)
-- [Platfrom Support](#platform-support)
-- [API](#api)
-- [Examples](#examples)
-- [Contributing](#contributing)
+<details>
+<summary><strong>Table of Contents</strong></summary>
+<!-- Do not edit the Table of Contents, instead regenerate with `npm run build-toc` -->
+
+<!-- toc -->
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Key features](#key-features)
+* [Platform support](#platform-support)
+* [API](#api)
+  + [const object = observable(object)](#const-object--observableobject)
+  + [const boolean = isObservable(object)](#const-boolean--isobservableobject)
+  + [const function = observe(function)](#const-function--observefunction)
+  + [unobserve(function)](#unobservefunction)
+  + [unqueue(function)](#unqueuefunction)
+  + [exec(function)](#execfunction)
+  + [const promise = nextTick(function)](#const-promise--nexttickfunction)
+  + [observable.$raw](#observableraw)
+* [Examples](#examples)
+* [Alternative builds](#alternative-builds)
+* [Contributing](#contributing)
+
+<!-- tocstop -->
+
+</details>
 
 ## Installation
 
@@ -332,6 +349,17 @@ setTimeout(() => user.job = 'stylist')
 setTimeout(() => delete user.name)
 ```
 
+## Alternative builds
+
+This library detects if you use ES6 or commonJS modules and serve the right format to you. The exposed bundles are transpiled to ES5 to support common tools - like UglifyJS minifying. If you would like a finer control over the provided build, you can specify them in your imports.
+
+- `@nx-js/observer-util/dist/es.es6.js` exposes an ES6 build with ES6 modules.
+- `@nx-js/observer-util/dist/es.es5.js` exposes an ES5 build with ES6 modules.
+- `@nx-js/observer-util/dist/cjs.es6.js` exposes an ES6 build with commonJS modules.
+- `@nx-js/observer-util/dist/cjs.es5.js` exposes an ES5 build with commonJS modules.
+
+If you use a bundler, set up an alias for `@nx-js/observer-util` to point to your desired build. You can learn how to do it with webpack [here](https://webpack.js.org/configuration/resolve/#resolve-alias) and with rollup [here](https://github.com/rollup/rollup-plugin-alias#usage).
+
 ## Contributing
 
 Contributions are always welcomed! Just send a PR for fixes and doc updates and open issues for new features beforehand. Make sure that the tests and the linter pass and that

karma.conf.js

@@ -8,12 +8,13 @@
     "dist"
   ],
   "scripts": {
-    "test": "karma start karma.conf.js",
+    "test": "node ./scripts/test.js",
     "test-builds": "node ./scripts/testBuilds.js",
     "lint": "standard",
-    "lint-fix": "prettier --ignore-path '.gitignore' --write '**/*.js' && standard --fix",
+    "lint-fix": "prettier --ignore-path '.gitignore' --write '**/!(bundle).js' && standard --fix",
     "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls",
-    "build": "node ./scripts/build.js"
+    "build": "node ./scripts/build.js",
+    "build-toc": "node ./scripts/buildToc.js"
   },
   "author": {
     "name": "Miklos Bertalan",
@@ -55,6 +56,7 @@
     "karma-mocha": "^1.3.0",
     "karma-rollup-preprocessor": "^5.0.1",
     "karma-source-map-support": "^1.2.0",
+    "markdown-toc": "^1.1.0",
     "mocha": "^3.5.0",
     "nyc": "11.1.0",
     "pre-push": "^0.1.1",

package.json

@@ -0,0 +1,9 @@
+const fs = require('fs')
+const path = require('path')
+const toc = require('markdown-toc')
+
+const readmePath = path.resolve('README.md')
+const oldReadme = fs.readFileSync(readmePath, 'utf8')
+const newReadme = toc.insert(oldReadme, { maxdepth: 3, bullets: ['*', '+'] })
+
+fs.writeFileSync(readmePath, newReadme)

scripts/buildToc.js

@@ -0,0 +1,63 @@
+const path = require('path')
+const resolve = require('rollup-plugin-node-resolve')
+const commonjs = require('rollup-plugin-commonjs')
+const babel = require('rollup-plugin-babel')
+const coverage = require('rollup-plugin-coverage')
+const alias = require('rollup-plugin-alias')
+const TestServer = require('karma').Server
+
+const bundleType = process.env.BUNDLE_TYPE
+const bundlePath = bundleType ? `dist/${bundleType}.js` : 'src/index.js'
+
+const config = {
+  frameworks: ['mocha', 'chai', 'source-map-support'],
+  reporters: ['progress', 'coverage'],
+  files: ['tests/**/*.test.js'],
+  preprocessors: {
+    'tests/**/*.test.js': ['rollup']
+  },
+  rollupPreprocessor: {
+    plugins: [
+      resolve(),
+      commonjs({
+        namedExports: {
+          'node_modules/chai/index.js': ['expect']
+        }
+      }),
+      alias({
+        '@nx-js/observer-util': path.resolve(bundlePath)
+      }),
+      coverage({
+        include: ['src/**/*.js']
+      }),
+      babel({
+        exclude: 'node_modules/**'
+      })
+    ],
+    format: 'iife',
+    name: 'observer',
+    sourcemap: 'inline'
+  },
+  coverageReporter: {
+    dir: 'coverage',
+    reporters: [{ type: 'lcov', subdir: '.' }, { type: 'text-summary' }]
+  },
+  port: 9876,
+  colors: true,
+  autoWatch: false,
+  concurrency: Infinity,
+  singleRun: true,
+  browsers: ['ChromeHeadlessNoSandbox'],
+  customLaunchers: {
+    ChromeHeadlessNoSandbox: {
+      base: 'ChromeHeadless',
+      flags: ['--no-sandbox']
+    }
+  }
+}
+
+const testServer = new TestServer(config, exitCode => {
+  console.log(`Karma has exited with ${exitCode}`)
+  process.exit(exitCode)
+})
+testServer.start()