Merge bc72241 into f0a7c73

README.md

@@ -1,25 +1,12 @@
-<a name="module_@zakkudo/query-string"></a>
-
 # @zakkudo/query-string
-<p>
+
 Make working with url query-strings enjoyable.
-</p>
-
-<p>
-<a href="https://travis-ci.org/zakkudo/query-string">
-    <img src="https://travis-ci.org/zakkudo/query-string.svg?branch=master"
-         alt="Build Status" /></a>
-<a href="https://coveralls.io/github/zakkudo/query-string?branch=master">
-    <img src="https://coveralls.io/repos/github/zakkudo/query-string/badge.svg?branch=master"
-         alt="Coverage Status" /></a>
-<a href="https://snyk.io/test/github/zakkudo/query-string">
-    <img src="https://snyk.io/test/github/zakkudo/query-string/badge.svg"
-         alt="Known Vulnerabilities"
-         data-canonical-src="https://snyk.io/test/github/zakkudo/query-string"
-         style="max-width:100%;" /></a>
-</p>
-
-<h3>Why use this?</h3>
+
+[![Build Status](https://travis-ci.org/zakkudo/query-string.svg?branch=master)](https://travis-ci.org/zakkudo/query-string)
+[![Coverage Status](https://coveralls.io/repos/github/zakkudo/query-string/badge.svg?branch=master)](https://coveralls.io/github/zakkudo/query-string?branch=master)
+[![Known Vulnerabilities](https://snyk.io/test/github/zakkudo/query-string/badge.svg)](https://snyk.io/test/github/zakkudo/query-string)
+
+## Why use this?
 
 - Consistancy with simplicity
 - The instance acts like a plain-old-object
@@ -28,7 +15,7 @@ Make working with url query-strings enjoyable.
   Update the properties after initialization and the serialization will reflect the updates
 - Complex params are automatically serialized and deserialized from json
 
-<h3>Install</h3>
+## Install
 
 ```console
 # Install using npm
@@ -40,8 +27,10 @@ npm install @zakkudo/query-string
 yarn add @zakkudo/query-string
 ```
 
-**Example** *(Initializing with an object)*  
-```js
+## Examples
+
+### Initializing with an object
+```javascript
 import QueryString from '@zakkudo/query-string';
 
 const query = new QueryString({
@@ -54,9 +43,12 @@ String(query) // '?page=3&title=awesomeness&complex=%7B%22test%22%3A%22value%22%
 query.toString() // '?page=3&title=awesomeness&complex=%7B%22test%22%3A%22value%22%7D&'
 
 const url = `http://example${query}` //Automatically serializes correctly
+
+const url = `http://example${query}` //Automatically serializes correctly with changes
 ```
-**Example** *(Initializing with a URL)*  
-```js
+
+### Initializing with a URL and making changes dynamically
+```javascript
 import QueryString from '@zakkudo/query-string';
 
 const query = new QueryString('http://example?page=3&title=awesomeness');
@@ -66,8 +58,9 @@ delete query.page;
 String(query) // '?title=awesomeness'
 query.toString() // '?title=awesomeness'
 ```
-**Example** *(Parsing an invalid query string with duplicate &#x27;?&#x27;)*  
-```js
+
+### Error handling
+```javascript
 import QueryString from '@zakkudo/query-string';
 import QueryStringError from '@zakkudo/query-string/QueryStringError';
 
@@ -82,14 +75,17 @@ try {
 }
 ```
 
-<a name="module_@zakkudo/query-string..QueryString"></a>
+## API
+
+<a name="module_@zakkudo/query-string"></a>
 
-## @zakkudo/query-string~QueryString ⏏
-**Kind**: Exported class [<code>@zakkudo/query-string</code>](#module_@zakkudo/query-string)  
+<a name="module_@zakkudo/query-string..QueryString"></a>
 
+### @zakkudo/query-string~QueryString ⏏
+**Kind**: Exported class
 <a name="new_module_@zakkudo/query-string..QueryString_new"></a>
 
-### new QueryString(data)
+#### new QueryString(data)
 **Throws**:
 
 - [<code>QueryStringError</code>](#module_@zakkudo/query-string/QueryStringError..QueryStringError) On issues parsing or serializing the configuration
@@ -98,29 +94,24 @@ try {
 | --- | --- | --- |
 | data | <code>String</code> \| <code>Object</code> \| <code>QueryString</code> | Initial data.  A url `String` will be parsed, and `Object`/`QueryString` instances will be copied. |
 
-<a name="module_@zakkudo/query-string..QueryString+toString"></a>
-
-### queryString.toString() ⇒ <code>String</code>
-Converts the object into its serialized query string representation
-that can be used in a url.
-
-**Kind**: instance method of [<code>QueryString</code>](#module_@zakkudo/query-string..QueryString)  
-**Returns**: <code>String</code> - The serialized representation of the `QueryString`.  It
-will be an empty string if there are no params to serialize.  
 <a name="module_@zakkudo/query-string/QueryStringError"></a>
 
 <a name="module_@zakkudo/query-string/QueryStringError..QueryStringError"></a>
 
-## @zakkudo/query-string/QueryStringError~QueryStringError ⇐ <code>Error</code> ⏏
+### @zakkudo/query-string/QueryStringError~QueryStringError ⇐ <code>Error</code> ⏏
 Error class used by QueryString for raising errors
 generated during parsing or serialization.
 
-**Kind**: Exported class [<code>@zakkudo/query-string/QueryStringError</code>](#module_@zakkudo/query-string/QueryStringError)  
+**Kind**: Exported class
 **Extends**: <code>Error</code>  
 
+* [~QueryStringError](#module_@zakkudo/query-string/QueryStringError..QueryStringError) ⇐ <code>Error</code>
+    * [new QueryStringError(message, url)](#new_module_@zakkudo/query-string/QueryStringError..QueryStringError_new)
+    * [.url](#module_@zakkudo/query-string/QueryStringError..QueryStringError+url)
+
 <a name="new_module_@zakkudo/query-string/QueryStringError..QueryStringError_new"></a>
 
-### new QueryStringError(message, url)
+#### new QueryStringError(message, url)
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -129,7 +120,7 @@ generated during parsing or serialization.
 
 <a name="module_@zakkudo/query-string/QueryStringError..QueryStringError+url"></a>
 
-### queryStringError.url
+#### queryStringError.url
 The related url fragment when the error was generated
 
 **Kind**: instance property of [<code>QueryStringError</code>](#module_@zakkudo/query-string/QueryStringError..QueryStringError)  

jsdoc.config.json

@@ -16,6 +16,7 @@
     "opts": {
         "destination": "./documentation",
         "recurse": true,
-        "encoding": "utf8"
+        "encoding": "utf8",
+        "readme": "src/README.md"
     }
 }

scripts/build.sh

@@ -2,5 +2,23 @@
 
 set -e
 
-./node_modules/.bin/babel src --out-dir build --source-maps inline --ignore "src/test.js" --ignore "src/*.test.js"
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./scripts/clean.sh
+./scripts/document.sh
+
+mkdir build
+
 cp package.json build/package.json
+cp README.md build/README.md
+
+./node_modules/.bin/babel src \
+    --out-dir build \
+    --source-maps inline \
+    --ignore "src/test.js" \
+    --ignore "src/*.test.js" \
+    --verbose \
+    "$@"

scripts/clean.sh

@@ -2,12 +2,13 @@
 
 set -e
 
+CURRENT_DIR=$(pwd)
 PROJECT_DIR=$(git rev-parse --show-toplevel)
-BIN_DIR=$(npm bin)
-JSDOC="$BIN_DIR/jsdoc"
-
-rm -rf $PROJECT_DIR/build
-rm -rf $PROJECT_DIR/coverage
-rm -rf $PROJECT_DIR/documentation
-rm -f $PROJECT_DIR/jsdoc.*.conf.tmp
-rm -f $PROJECT_DIR/yarn-error.log
+
+cd $PROJECT_DIR
+
+rm -rf build
+rm -rf coverage
+rm -rf documentation
+rm -f jsdoc.*.conf.tmp
+rm -f yarn-error.log

scripts/cover.sh

@@ -1,4 +1,11 @@
-#!/bin/sh
+#!/bin/bash
 
-yarn clean
-./node_modules/.bin/jest --coverage --runInBand
+set -e
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./scripts/clean.sh
+./scripts/test.sh --coverage "$@"

scripts/deploy.sh

@@ -2,10 +2,17 @@
 
 set -e
 
-yarn cover
-yarn build
-yarn document
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
 
-cp README.md build/README.md
+cd $PROJECT_DIR
+
+./scripts/cover.sh
+./scripts/document.sh
+./scripts/build.sh
+
+yarn version
+
+./scripts/build.sh
 
 yarn publish --access public --cwd build --no-git-tag-version

scripts/document.sh

@@ -2,12 +2,21 @@
 
 set -e
 
+CURRENT_DIR=$(pwd)
 PROJECT_DIR=$(git rev-parse --show-toplevel)
 BIN_DIR=$(npm bin)
 JSDOC="$BIN_DIR/jsdoc"
+OPTIONS="--module-index-format none --global-index-format none --example-lang js --heading-depth 3"
 
-$JSDOC -c $PROJECT_DIR/jsdoc.config.json "$@"
-./node_modules/.bin/jsdoc2md src/index.js src/QueryStringError.js --module-index-format none --global-index-format none --example-lang js --heading-depth 1 > README.md
-./scripts/postProcessReadme.js README.md
+cd $PROJECT_DIR
 
+$JSDOC -c jsdoc.config.json "$@"
+cat src/README.md > README.md
 
+echo "" >> README.md
+echo "## API" >> README.md
+echo "" >> README.md
+
+node_modules/.bin/jsdoc2md src/index.js src/QueryStringError.js $OPTIONS >> README.md
+
+scripts/postProcessReadme.js README.md

scripts/lint.sh

@@ -1,3 +1,10 @@
-#!/bin/sh
+#!/bin/bash
 
-./node_modules/.bin/eslint src
+set -e
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./node_modules/.bin/eslint src "$@"

scripts/postProcessReadme.js

@@ -8,32 +8,42 @@ const contents = String(fs.readFileSync(filename));
 const lines = contents.split('\n');
 
 let isIndex = false;
+let isApiSection = false;
 
-const newContents = lines.filter((l, index) => {
-    if (l.startsWith('# ') && lines[index + 2] && lines[index + 2].startsWith('* [')) {
-        isIndex = true;
-    }
-
-    if (l.startsWith('* [')) {
+const newContents = lines.filter((l) => {
+    if (l.startsWith('* [@')) {
         isIndex = true;
     } else if (l === '') {
         isIndex = false;
     }
 
     return !isIndex;
+}).filter((l) => {
+     return !l.startsWith('### @');
 }).map((l, index, lines) => {
     const innerClassOfPrefix = '**Kind**: inner class of';
 
-    if (l.startsWith('## ')) {
+    if (l.startsWith('#### @')) {
         return l + ' ⏏';
     }
 
     if (l.startsWith(innerClassOfPrefix)) {
-        return '**Kind**: Exported class' + l.slice(innerClassOfPrefix.length);
+        return '**Kind**: Exported class';
+    }
+
+    return l;
+}).map((l, index, lines) => {
+    if (l === '## API') {
+        isApiSection = true;
+        return l;
+    }
+
+    if (isApiSection && l.startsWith('##')) {
+        return l.slice(1);
     }
 
     return l;
-}).join('\n').replace(/\n\n+/gm, '\n\n');;
+}).join('\n').replace(/\n\n+/gm, '\n\n').replace('@', '@').replace('/', '/');
 
 fs.writeFileSync(filename, newContents);
 

scripts/test.sh

@@ -1,4 +1,11 @@
-#!/bin/sh
+#!/bin/bash
 
-yarn clean
-./node_modules/.bin/jest --runInBand
+set -e
+
+CURRENT_DIR=$(pwd)
+PROJECT_DIR=$(git rev-parse --show-toplevel)
+
+cd $PROJECT_DIR
+
+./scripts/clean.sh
+./node_modules/.bin/jest --runInBand "$@"