packaging: merge public API into a single repository

fulls1z3 · Sep 4, 2017 · 68f8f5b · 68f8f5b
1 parent e212f99
commit 68f8f5b
Show file tree

Hide file tree

Showing 61 changed files with 2,594 additions and 631 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,39 +1,50 @@
 <!--
-IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION WE MIGHT CLOSE YOUR ISSUE WITHOUT INVESTIGATING
+PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
+
+ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
 -->
 
 **I'm submitting a ...**  (check one with "x")
 ```
-[ ] bug report => check the README and search github for a similar issue or PR before submitting
-[ ] support request => check the README and search github for a similar issue or PR before submitting
-[ ] feature request
+[ ] Regression (a behavior that used to work and stopped working in a new release)
+[ ] Bug report  <!-- Please check the repository for a similar issue or PR before submitting -->
+[ ] Support request => <!-- Please check the repository for a similar issue or PR before submitting -->
+[ ] Feature request
+[ ] Documentation issue or request
 ```
 
 **Current behavior**
-<!-- Describe how the bug manifests. -->
+<!-- Describe how the issue manifests. -->
 
 **Expected/desired behavior**
-<!-- Describe what the behavior would be without the bug. -->
+<!-- Describe what the desired behavior would be. -->
 
 **Minimal reproduction of the problem with instructions**
 <!--
-If the current behavior is a bug or you can illustrate your feature request better with an example, 
-please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via
+For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via
 https://plnkr.co or similar (you can use this template as a starting point: http://plnkr.co/edit/tpl:AvJOMERrnz94ekVua0u5).
 -->
 
 **What is the motivation / use case for changing the behavior?**
-<!-- Describe the motivation or the concrete use case -->
-
-**Please tell us about your environment:**
-<!-- Operating system, IDE, package manager, HTTP server, ... -->
+<!-- Describe the motivation or the concrete use case. -->
 
-* **Angular version:** 2.0.X
+**Environment**
+* **Angular version:** X.Y.Z
 <!-- Check whether this is still an issue in the most recent Angular version -->
 
-* **Browser:** [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
-<!-- All browsers where this could be reproduced -->
-
-* **Language:** [all | TypeScript X.X | ES6/7 | ES5]
-
-* **Node (for AoT issues):** `node --version` =   
+* **Browser:**
+- [ ] Chrome (desktop) version XX
+- [ ] Chrome (Android) version XX
+- [ ] Chrome (iOS) version XX
+- [ ] Firefox version XX
+- [ ] Safari (desktop) version XX
+- [ ] Safari (iOS) version XX
+- [ ] IE version XX
+- [ ] Edge version XX
+
+* **For Tooling issues:**
+- Node version: XX  <!-- run `node --version` -->
+- Platform:  <!-- Mac, Linux, Windows -->
+
+* Others:
+<!-- Anything else relevant?  Operating system version, IDE, package manager, HTTP server, ... -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+** PR Checklist
+Please check if your PR fulfills the following requirements:
+
+- [ ] The commit message follows our guidelines: https://github.com/fulls1z3/ngx-cache/blob/master/CONTRIBUTING.md#commit
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Docs have been added / updated (for bug fixes / features)
+
+** PR Type
+What kind of change does this PR introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+```
+[ ] Bugfix
+[ ] Feature
+[ ] Code style update (formatting, local variables)
+[ ] Refactoring (no functional changes, no api changes)
+[ ] Build related changes
+[ ] CI related changes
+[ ] Documentation content changes
+[ ] Other... Please describe:
+```
+
+** What is the current behavior?
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: N/A
+
+** What is the new behavior?
+
+** Does this PR introduce a breaking change?
+```
+[ ] Yes
+[ ] No
+```
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
+
+** Other information
diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,7 @@ yarn.lock
 coverage/
 !gulpfile.js
 !karma.conf.js
+!spec-bundle.js
 
 # misc
 !config/*.js

diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,29 @@
+{
+  "bitwise": true,
+  "eqeqeq": true,
+  "forin": true,
+  "noarg": true,
+  "noempty": true,
+  "nonbsp": true,
+  "nonew": true,
+  "undef": true,
+  "varstmt": true,
+  "esversion": 6,
+  "latedef": true,
+  "unused": true,
+  "indent": 2,
+  "quotmark": "single",
+  "maxcomplexity": 20,
+  "maxlen": 140,
+  "maxerr": 50,
+  "globals": {},
+  "strict": true,
+  "laxbreak": true,
+  "loopfunc": true,
+  "browser": true,
+  "module": true,
+  "node": true,
+  "trailing": true,
+  "onevar": true,
+  "white": true
+}
diff --git a/.travis.yml b/.travis.yml
@@ -21,7 +21,7 @@ before_script:
   - npm i -g npm@^3
   - sleep 3
 after_failure:
-  - cat /home/travis/build/ngx-cache/core/npm-debug.log
+  - cat /home/travis/build/fulls1z3/ngx-cache/npm-debug.log
 after_success:
   - bash <(curl -s https://codecov.io/bash)
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,26 +1,35 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## Current iteration
+### Breaking changes
+- **packaging:** merge public API into a single repository
+
 ## v0.4.0-beta.2 - 2017-06-07
-### Added
-- Added wildcard support to remove items (closes [#6](https://github.com/ngx-cache/core/issues/6))
+### Breaking changes
+- **packaging:** `@ngx-storage/fs` has been renamed to `@ngx-cache/fs-storage`
 
-### Fixed
-- Resolved cacheKey doesn't handle optional (undefined) or null parameters (closes [#5](https://github.com/ngx-cache/core/issues/5))
+### Bug fixes
+- **core:** cacheKey doesn't handle optional (undefined) or null parameters (closes [#5](https://github.com/fulls1z3/ngx-cache/issues/5))
+- **fs-storage:** `fs.mkdir` fails while creating `./temp/cache`
 
-### Changed
-- Updated deps, gulp tasks, webpack config, tslint
-- Some refactoring
+### Features
+- **core:** wildcard support to remove items (closes [#6](https://github.com/fulls1z3/ngx-cache/issues/6))
+- **platform-browser:** wildcard support to remove items (closes [#6](https://github.com/fulls1z3/ngx-cache/issues/6))
+- **platform-server:** wildcard support to remove items (closes [#6](https://github.com/fulls1z3/ngx-cache/issues/6))
 
 ## v0.4.0-beta.1 - 2017-04-28
-### Added
-- Added abstract storage (closes [#4](https://github.com/ngx-cache/core/issues/4))
-
-### Fixed
-- Resolved add `yarn.lock` to npmignore (closes [#2](https://github.com/ngx-cache/core/issues/2))
-- Resolved cannot get instance of CacheService (closes [#3](https://github.com/ngx-cache/core/issues/3))
-- Resolved error on AoT compilation (closes [#1](https://github.com/ngx-cache/core/issues/1))
+### Bug fixes
+- **core:** add `yarn.lock` to npmignore (closes [#2](https://github.com/fulls1z3/ngx-cache/issues/2))
+- **core:** cannot get instance of CacheService (closes [#3](https://github.com/fulls1z3/ngx-cache/issues/3))
+- **core:** error on AoT compilation (closes [#1](https://github.com/fulls1z3/ngx-cache/issues/1))
+- **platform-browser:** add `yarn.lock` to npmignore (closes [#2](https://github.com/fulls1z3/ngx-cache/issues/2))
+- **platform-browser:** cannot get instance of CacheService
+- **platform-server:** add `yarn.lock` to npmignore (closes [#2](https://github.com/fulls1z3/ngx-cache/issues/2))
+- **platform-server:** cannot get instance of CacheService
+- **fs-storage:** add `yarn.lock` to npmignore (closes [#2](https://github.com/fulls1z3/ngx-cache/issues/2))
 
-### Changed
-- Updated README.md
-- Updated deps, ignorers
+### Features
+- **core:** abstract storage (closes [#4](https://github.com/fulls1z3/ngx-cache/issues/4))
+- **platform-browser:** prevent rehydrate without STATE_ID
+- **platform-browser:** import STORAGE from `@ngx-config/core`
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/