Merge pull request #21 from pklaschka/develop

v1.0.0

Author: pklaschka

.eslintrc.js

@@ -0,0 +1,30 @@
+module.exports = {
+    "env": {
+        "es6": true,
+        "node": true,
+        "commonjs": true,
+        "browser": true,
+        "jest": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 2018
+    },
+    "rules": {
+        "indent": [
+            "error",
+            4
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ],
+        "no-console": "error",
+        "valid-jsdoc": "error",
+        "max-len": ["error", { "code": 120 }]
+    }
+};

.npmignore

@@ -5,3 +5,7 @@ tests
 coverage
 .travis.yml
 .github
+src
+tsconfig.json
+webpack.config.js
+.eslintrc.js

.travis.yml

@@ -1,3 +1,13 @@
 language: node_js
 node_js:
-  - "node"
+  - "node"
+
+sudo: false
+
+install:
+  - npm install
+  - npm install -g coveralls
+
+script:
+  - npm test
+  - cat ./coverage/lcov.info | coveralls

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Pablo Klaschka
+Copyright (c) 2019 Pablo Klaschka
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -36,3 +36,33 @@ const dialogHelper = require('./lib/dialog-helper');
 
 #### Documentation for the library
 You can find a detailed guide on how to use the library in the [repository wiki](https://github.com/pklaschka/xd-dialog-helper/wiki).
+
+### Migrating to v1.0.0
+Mostly, there should be no breaking changes (but many additional options and improvements) in v1.0, since it mostly consists of an internal restructuring.
+
+However, with the release of the new version, the types have moved to a
+`types` namespace inside the `xd-dialog-helper` module.
+
+This  means that instead of writing
+
+```js
+dialogHelper.showDialog('dialog', 'My dialog', [{
+    id: 123,
+    type: dialogHelper.TEXT_INPUT,
+    label: 'Good morning'
+}]);
+```
+
+we have to write:
+
+```js
+dialogHelper.showDialog('dialog', 'My dialog', [{
+    id: 123,
+    type: dialogHelper.types.TEXT_INPUT,
+    label: 'Good morning'
+}]);
+```
+
+> **Please note:** The old way is still available (but marked as deprecated) in the alpha- and beta versions of v1.0. It will, however, get removed with the full release of the new version.
+
+Also, the type constant previously were aliases for numeric constants representing the type. This is no longer the case (to support custom types), which is why numeric values are no longer possible for the `type` field.