Merge pull request #6 from georapbox/ver2

Closes #3

Author: georapbox

.babelrc

@@ -1,6 +1,3 @@
 {
-  "presets": ["es2015"],
-  "plugins": [
-    "babel-plugin-add-module-exports"
-  ]
+  "presets": ["@babel/env"]
 }

.codeclimate.yml

@@ -17,7 +17,7 @@ ratings:
   paths:
   - src/**
 exclude_paths:
-- lib/**/*
+- dist/**/*
 - test/**/*
 - coverage/**/*
 - .nyc_output/**/*

.eslintignore

@@ -0,0 +1,2 @@
+/dist/**
+/lib/**

.eslintrc.json

@@ -276,7 +276,7 @@
     "no-whitespace-before-property": 1,
 
     // enforce consistent spacing inside braces
-    "object-curly-spacing": [1, "never"],
+    "object-curly-spacing": 0,
 
     // enforce the consistent use of either backticks, double, or single quotes
     "quotes": [1, "single", {"avoidEscape": true, "allowTemplateLiterals": true}],

.gitignore

@@ -1,14 +1,65 @@
-# dependencies
-/node_modules
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
 
-# testing
-/coverage
+# nyc test coverage
 .nyc_output
 
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# production
+dist
+lib
+
 # misc
 .DS_Store
-.env
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-demo.js

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - 8.1.3
+  - 8.11.1
 branches:
   only:
     - master

CHAGELOG.md

@@ -1,14 +1,31 @@
 # CHANGELOG
 
+## v2.0.0
+
+### BREAKING CHANGES
+
+> The library's API has not breaking changes. All breaking changes refer to how the final distributed files are bundled and their locations in the project.
+
+- All distributed files are located under the `dist/` directory instead of `lib/` which was in v1.x.x. The UMD format is located under `dist/umd/` directory and the CommonJS under the `dist/commonjs/` directory.
+- The directory containing the distributed files is no longer included in GIT.
+
+### OTHER CHANGES
+
+- All `devDependencies` are updated to latest versions. Updated Webpack to v4.x.x and Babel to v7.x.x.
+- The library is now exported in both UMD (as was in version 1.x.x) and CommonJS. For CommonJS, the libdary's methods are also exported as standalone functions in order to import only the ones you want for your project. Check the [Usage](https://github.com/georapbox/immutable-arrays/blob/master/README.md#usage) section in README for more details.
+
+
 ## v1.0.3
 
 - Fixes issue #4. Do not copy array unnecessarily in `del` method if index is a negative number.
 
+
 ## v1.0.2
 
 - Use the array spread operator in delete method.
 - Keep devDependencies up to date.
 
+
 ## v1.0.1
 
 - Keep devDependencies up to date.
@@ -32,14 +49,17 @@ Below is a list with the renamed methods:
 - `immutableSort` renamed to `sort`;
 - `immutableDelete` renamed to `del`;
 
+
 ## v0.4.3
 - Include test coverage in build process
 - Add test to cover scenario with all optional arguments being undefined for immutableSplice method
 
+
 ## v0.4.2
 - Keep devDependencies up to date
 - Add code climate integration
 - Add test coverage report
 
+
 ## v0.4.1
 - Fix bug while deleting an element at 0 index [(#1)](https://github.com/georapbox/immutable-arrays/pull/1)

README.md

@@ -21,16 +21,29 @@ $ npm install --save immutable-arrays
 
 ## Usage
 
+The library is exported in `UMD` and `CommonJS` formats under `dist/umd` and `dist/commonjs` directories respectively.
+It can be used both in Browser and Node environments.  
+In Node environment or if you use a bundler (eg Webpack), the library also exports all of its methods as CommonJS standalone functions under the `dist/commonjs` directory.
+
 ### Old school browser global
 ```html
-<script src="immutable-arrays/lib/immutableArrays.min.js"></script>
+<script src="immutable-arrays/dist/umd/immutable-arrays.min.js"></script>
 ```
 
 ### Node.js
+
+#### Import the whole library
+
 ```js
 const immutableArrays = require('immutable-arrays');
 ```
 
+#### Import only the module you need <sup>New in version 2.x.x</sup>
+
+```js
+const push = require('immutable-arrays/dist/commonjs/push').default;
+```
+
 ### ES2015 imports
 
 #### Import default export
@@ -39,22 +52,22 @@ const immutableArrays = require('immutable-arrays');
 import immutableArrays from 'immutable-arrays';
 ```
 
-#### Import a single export
+#### Import a named export (bundlers like Webpack will still include the whole library)
 
 ```js
-import {push} from 'immutable-arrays';
+import { push } from 'immutable-arrays';
 ```
 
-#### Import multiple exports
+#### Import only the module you need <sup>New in version 2.x.x</sup>
 
 ```js
-import {push, pop, shift} from 'immutable-arrays';
+import push from 'immutable-arrays/dist/commonjs/push';
 ```
 
-#### Import ES2015 (uncompiled) method from source
+#### Import ES2015 (uncompiled) function from source
 
 ```js
-import push from 'immutable-arrays/src/immutable-push';
+import push from 'immutable-arrays/src/push';
 ```
 
 ## API
@@ -258,18 +271,32 @@ const resultArray = immutableArrays.del(originalArray, 2);
 // -> originalArray ['a', 'b', 'c', 'd', 'e']
 // -> resultArray ['a', 'b', 'd', 'e']
 
-const resultArray2 = immutableDelete(originalArray, -1);
+const resultArray2 = immutableArrays.del(originalArray, -1);
 // -> originalArray ['a', 'b', 'c', 'd', 'e']
 // -> resultArray2 ['a', 'b', 'c', 'd', 'e']
 ```
 
-## Test
+## For developers
+
+### Build the library
+
+```sh
+$ npm run dev
+```
+Builds the library and watches for changes while developing. If you want to build only for a specific format, there are other npm scripts available; check in `package.json`.
+
+```sh
+$ npm run build
+```
+Builds the library for production.
+
+### Run the tests
 
 ```sh
-$ npm test
+$ npm run test
 ```
 
-## Test Coverage
+### Tests coverage
 
 ```sh
 $ npm run coverage

index.js

@@ -0,0 +1 @@
+module.exports = require('./src').default;