V2 refactor

.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+
+[{package.json}]
+indent_style = space
+indent_size = 2

.eslintrc.js

@@ -1,35 +1,101 @@
+const restrictedGlobals = require('eslint-restricted-globals')
+  .filter(name => name !== 'self');
+
 module.exports = {
-  'parser': 'babel-eslint',
-  'extends': 'airbnb-base',
-  'rules': {
-    'indent': ['error', 2],
-    'padded-blocks': 0,
-    'class-methods-use-this': ['error', { 'exceptMethods': ['boot'] }],
-    'no-useless-constructor': 0,
-    'no-param-reassign': 0,
-    'no-console': 0,
-    'no-return-assign': 0,
-    'prefer-rest-params': 0,
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    sourceType: 'module',
+    ecmaVersion: 2018,
+  },
+  extends: [
+    'airbnb-base',
+    'plugin:@typescript-eslint/recommended',
+    'prettier/@typescript-eslint',
+    'plugin:prettier/recommended',
+  ],
+  globals: {
+    chrome: true,
+    it: true,
+    xit: true,
+    describe: true,
+    beforeAll: true,
+    beforeEach: true,
+    afterEach: true,
+    afterAll: true,
+    before: true,
+    after: true,
+    chai: true,
+    sinon: true,
+    expect: true,
+    jest: true,
+    test: true,
+    cy: true,
+    Cypress: true,
+  },
+  env: {
+    browser: true,
+    node: true,
+  },
+  rules: {
+    'arrow-parens': ['error', 'as-needed'],
+    'class-methods-use-this': 0,
+    'comma-dangle': ['error', 'always-multiline'],
+    'curly': ['error', 'all'],
     'consistent-return': 0,
-    'space-before-function-paren': 0,
-    'valid-jsdoc': ['error', {
-      'prefer': { 'return': 'return' },
-      'preferType': { 'Boolean': 'Boolean', 'Number': 'Number', 'object': 'Object', 'String': 'String' },
-      'requireReturn': false,
-      'requireParamDescription': false,
-      'requireReturnDescription': false
-    }]
+    'dot-notation': [2, { allowPattern: '^[a-z]+(_[a-z]+)+$' }],
+    'func-names':2,
+    'function-paren-newline': 0,
+    'func-style': [ 'error', 'declaration', { 'allowArrowFunctions': false } ],
+    'global-require': 0,
+    'import/extensions': 0,
+    'import/export': 0,
+    'import/named': 2,
+    'import/no-default-export': 0,
+    'import/no-extraneous-dependencies': 0,
+    'import/no-unresolved': 0,
+    'import/prefer-default-export': 0,
+    'import/order': 2,
+    'implicit-arrow-linebreak': 0,
+    'linebreak-style': process.env.NODE_ENV !== 'production' ? 'off' : ['error', 'unix'],
+    'max-len': ['error', {
+      code: 150,
+      ignoreUrls: true,
+      ignoreStrings: true,
+      ignoreComments: true,
+      ignoreTemplateLiterals: true,
+      ignoreRegExpLiterals: true,
+      ignorePattern: '<p>|<p|<span>|<small>'
+    }],
+    'max-params': ['error', 3],
+    'no-console': 2,
+    'no-debugger': 1,
+    'no-nested-ternary': 0,
+    'no-plusplus': 0,
+    'no-mixed-operators': 0,
+    'no-param-reassign': ['error', { props: false }],
+    'no-use-before-define': 0,
+    'no-restricted-syntax': ['error', 'WithStatement'],
+    'no-return-assign': 0,
+    'no-restricted-globals': ['error'].concat(restrictedGlobals),
+    'operator-linebreak': [2, 'after', { 'overrides': { '?': 'before', ':': 'before' } }],
+    'object-curly-newline': 0,
+    'operator-linebreak': 0,
+    'prefer-destructuring': 0,
+    'require-jsdoc': 0,
+    'space-before-function-paren': ['error', 'never'],
+    'spaced-comment': 0,
+    'sort-keys': 0,
+    '@typescript-eslint/camelcase': 0,
+    '@typescript-eslint/indent': 0,
+    '@typescript-eslint/array-type': ['error', 'array'],
+    '@typescript-eslint/interface-name': [true, 'never'],
+    '@typescript-eslint/no-angle-bracket-type-assertion': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/no-namespace': 0,
+    '@typescript-eslint/no-object-literal-type-assertion': 0,
+    '@typescript-eslint/no-unused-vars': ['error'],
+    '@typescript-eslint/no-use-before-define': 0,
+    '@typescript-eslint/explicit-function-return-type': 0,
+    'valid-jsdoc': 0,
   },
-  'globals': {
-    'it': true,
-    'describe': true,
-    'beforeAll': true,
-    'beforeEach': true,
-    'afterEach': true,
-    'afterAll': true,
-    'before': true,
-    'after': true,
-    'expect': true,
-    'jest': true
-  }
 };

.gitignore

@@ -2,5 +2,33 @@
 /node_modules
 .nyc_output
 npm-debug.log
+# reference: https://github.com/github/gitignore/blob/master/Node.gitignore
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# IDEs config files
+.vscode/
+.idea/
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Yarn Integrity file
+.yarn-integrity
+
+# Others
 demo/node_modules
 /demo
+
+legacy

.prettierrc

@@ -0,0 +1,6 @@
+
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "singleQuote": true
+}

README.md

@@ -6,29 +6,36 @@
 [![npm](https://img.shields.io/npm/dt/rapid.js.svg?style=flat-square)](https://www.npmjs.com/package/rapid.js)
 [![npm](https://img.shields.io/travis/rapidjs/rapid.js.svg?branch=master&style=flat-square)](https://www.npmjs.com/package/rapid.js)
 
-##### An ORM-like Interface and a Router For Your API Requests
-###### Create simple, reusable, and cleaner wrappers, define custom routes, and more for your API requests.
+# r**api**d.js
+
+An ORM-like Interface and a Router For Your API Requests
+
+Create simple, reusable, and cleaner wrappers, define custom routes, and more for your API requests.
+
+## Documentation
 
 Read the official docs at [https://rapidjs.io](https://rapidjs.io).
 
 ## Installation
 
 Pick your poison:
 
-```
+```shell
 yarn add rapid.js
 npm i -S rapid.js
 npm install --save rapid.js
 ```
 
 ## Overview
- - [Define Simple Models](#define-simple-models)
- - [Easily Customize Your API Requests](#easily-customize-your-api-requests)
- - [Create Reusable Base Models](#create-reusable-base-models)
- - [Write API Wrappers For Your Endpoints](#write-api-wrappers-for-your-endpoints)
- - [Define Custom Routes (New!)](#define-custom-routes)
+
+- [Define Simple Models](#define-simple-models)
+- [Easily Customize Your API Requests](#easily-customize-your-api-requests)
+- [Create Reusable Base Models](#create-reusable-base-models)
+- [Write API Wrappers For Your Endpoints](#write-api-wrappers-for-your-endpoints)
+- [Define Custom Routes (New!)](#define-custom-routes)
 
 ### Define Simple Models
+
 ```js
 const post = new Rapid({ modelName: 'Post' });
 
@@ -51,11 +58,13 @@ post.destroy(9)
     // POST => /api/posts/9/destroy
 
 post.restore(9)
-    // POST => /api/posts/9/restore    
+    // POST => /api/posts/9/restore
 ```
+
 Read more about [Rapid Basics](https://rapidjs.io/docs#usage).
 
 ### Easily Customize Your API Requests
+
 ```js
 const post = new Rapid({
     modelName: 'Post',
@@ -75,9 +84,11 @@ post.update(25, { title: 'Rapid JS Is Awesome!' })
 post.destroy(9)
     // DELETE => /api/posts/9/
 ```
+
 Read more about [Customizing Your Requests](https://rapidjs.io/docs#config-builder).
 
 ### Create Reusable Base Models
+
 ```js
 class Base extends Rapid {
     boot () {
@@ -99,9 +110,11 @@ tag.collection.findBy('color', 'red')
 gallery.id(23).get('tags', 'nature')
     // GET => https://myapp.com/api/gallery/23/tag/nature?key=MY_API_KEY
 ```
+
 Read more about [Base Models](https://rapidjs.io/docs#extending-base-models).
 
 ### Write API Wrappers For Your Endpoints
+
 ```js
 class GalleryWrapper extends Rapid {
     boot () {
@@ -125,7 +138,8 @@ const gallery = new GalleryWrapper({
 gallery.tagSearch('nature').json().get().then(...);
     // GET https://myapp.com/gallery/api/tagsearch/json?query=nature&key=MY_API_KEY
     // GET https://myapp.com/gallery/api/tagsearch/json?query=nature&key=MY_API_KEY
-```    
+```
+
 Read more about [Making a Wrapper](https://rapidjs.io/docs#extending-making-a-wrapper).
 
 ### Define Custom Routes
@@ -155,6 +169,7 @@ router.route('web_save_user_preferences', { id: 12 }, /* { request data } */).th
 ```
 
 #### Using Your Own HTTP Service
+
 ```js
 import http from 'some-http-service';
 
@@ -178,6 +193,7 @@ rapid.generate('web_login')
 // use your own service
 http.post(rapid.generate('api_save_user_preferences', { id: 1 }), { data }).then()...
 ```
+
 Read more about [Custom Routes](https://rapidjs.io/docs#custom-routes).
 
 Read the official docs at [https://rapidjs.io](https://rapidjs.io).