Merge branch 'release/1.0.6'

compodoc · Feb 13, 2018 · 43df3ca · 43df3ca
2 parents 21ea6a4 + 8037673
commit 43df3ca
Show file tree

Hide file tree

Showing 123 changed files with 11,405 additions and 2,919 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -36,3 +36,6 @@
 
 <!-- if you can't fix the bug yourself, perhaps you can point to what might be
   causing the problem (line of code or commit) -->
+
+<!-- Love compodoc? Please consider supporting our collective:
+👉  https://opencollective.com/compodoc/donate -->
diff --git a/.npmignore b/.npmignore
@@ -1,6 +1,6 @@
 screenshots/
 tsconfig.json
-rollup.config.js
+rollup/
 test/
 coverage
 .nyc_output
@@ -12,4 +12,5 @@ codecov.yml
 appveyor.yml
 doc
 documentation
+docs
 package.json.old
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,7 @@ node_js:
   - "6"
   - "7"
   - "8"
+  - "9"
 addons:
   sauce_connect:
     username: "compodoc"
@@ -20,6 +21,9 @@ script:
     - if [ $TO_TEST == 'ALL' ];
       then npm run saucelabs-test-e2e-mocha;
       fi
+    - if [ $TO_TEST == 'OTHERS' ];
+      then npm run angularexpo;
+      fi
 after_success:
     - npm run codecov
 branches:
@@ -33,12 +37,15 @@ matrix:
     - node_js: "6"
     - node_js: "7"
     - node_js: "8"
+    - node_js: "9"
   include:
     - node_js: "4"
       env: TO_TEST=UNIT SAUCE_USERNAME=compodoc
     - node_js: "6"
-      env: TO_TEST=ALL SAUCE_USERNAME=compodoc
+      env: TO_TEST=UNIT SAUCE_USERNAME=compodoc
     - node_js: "7"
       env: TO_TEST=UNIT SAUCE_USERNAME=compodoc
     - node_js: "8"
-      env: TO_TEST=UNIT SAUCE_USERNAME=compodoc
+      env: TO_TEST=ALL SAUCE_USERNAME=compodoc
+    - node_js: "9"
+      env: TO_TEST=OTHERS SAUCE_USERNAME=compodoc
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,48 @@
+<a name="1.0.6"></a>
+# [1.0.6](https://github.com/compodoc/compodoc/compare/1.0.5...1.0.6) (2018-02-12)
+
+### Features
+
+* **prism:** Added SCSS support for code blocks ([2b983cc](https://github.com/compodoc/compodoc/commit/2b983cc)), closes [#398](https://github.com/compodoc/-compodoc/issues/398)
+Thanks [Martin Hobert](https://github.com/Epenance)
+* **additional-doc:** prepareExternalIncludes parses children recursively ([51aeae24a03c0287ca68cadf317294c5422c4fc7](https://github.com/compodoc/compodoc/commit/51aeae24a03c0287ca68cadf317294c5422c4fc7))
+Thanks [jabiinfante](https://github.com/jabiinfante)
+* **example-tab:** Added examples tab to services ([687b04ccc79521684063ebfc4c3d1f32956ec20c](https://github.com/compodoc/compodoc/commit/687b04ccc79521684063ebfc4c3d1f32956ec20c))
+Thanks [rprotsyk](https://github.com/rprotsyk)
+* **core:** downgrade TypeScript version ([fa74be96ffdeaa383b98d8708f0311edbf5b4640](https://github.com/compodoc/compodoc/commit/fa74be96ffdeaa383b98d8708f0311edbf5b4640)), closes [#359](https://github.com/compodoc/-compodoc/issues/359)
+* **core:** display project dependencies ([c7a768960f7329800f449a5d08e64e5d0ad07443](https://github.com/compodoc/compodoc/commit/15ce12c8fcc7a768960f7329800f449a5d08e64e5d0ad0744347be929865a21a8131ab035e8c80ae)), closes [#441](https://github.com/compodoc/-compodoc/issues/441)
+* **theme:** Support Google Analytics ([f126115763246c399e682ae79158ef0314395716](https://github.com/compodoc/compodoc/commit/f126115763246c399e682ae79158ef0314395716)), closes [#461](https://github.com/compodoc/-compodoc/issues/461)
+* **theme:** Material design theme ([d3f17301f92936932dabf2cc5d9bc24100faeb4e](https://github.com/compodoc/compodoc/commit/d3f17301f92936932dabf2cc5d9bc24100faeb4e)), closes [#418](https://github.com/compodoc/-compodoc/issues/418)
+* **coverage:** --coverageTestThresholdFail ([f79f280115abb66874e9bc707fab15f68d1bf114](https://github.com/compodoc/compodoc/commit/f79f280115abb66874e9bc707fab15f68d1bf114)), closes [#428](https://github.com/compodoc/-compodoc/issues/428)
+
+### Bug Fixes
+
+* **cli:** display error message for empty -p ([674772504abdc0984dce43de4b8b054fe9ac32e0](https://github.com/compodoc/compodoc/commit/674772504abdc0984dce43de4b8b054fe9ac32e0)), closes [#422](https://github.com/compodoc/-compodoc/issues/422)
+* **cli:** remove duplicate code ([eb25e1a5fe4650e69f3b2e90c66a1280ee217ccf](https://github.com/compodoc/compodoc/commit/eb25e1a5fe4650e69f3b2e90c66a1280ee217ccf))
+Thanks [Alan Agius](https://github.com/alan-agius4)
+* **dependencies:** Error if HTTP_INTERCEPTORS registered via providers ([89c333555b8b6a07fea9ec3a2e1cabf3d7da13a5](https://github.com/compodoc/compodoc/commit/89c333555b8b6a07fea9ec3a2e1cabf3d7da13a5)), closes [#456](https://github.com/compodoc/-compodoc/issues/456)
+* **dependencies:** show default values for function parameters ([163dc693b8dfd09671cd10e44de7cfa56237f574](https://github.com/compodoc/compodoc/commit/163dc693b8dfd09671cd10e44de7cfa56237f574)), closes [#453](https://github.com/compodoc/-compodoc/issues/453)
+* **dependencies:** private modifier for constructor ([016f96386a209c4d01214b3e2f93193d7d1db587](https://github.com/compodoc/compodoc/commit/016f96386a209c4d01214b3e2f93193d7d1db587)), closes [#458](https://github.com/compodoc/-compodoc/issues/458)
+* **dependencies:** optional for interfaces ([5e0845ecbb3ebad3037bbd81bb05015132d78945](https://github.com/compodoc/compodoc/commit/5e0845ecbb3ebad3037bbd81bb05015132d78945)), closes [#455](https://github.com/compodoc/-compodoc/issues/455)
+* **dependencies:** detect type annotation based on default values ([c80d15519e8bfa07625ba72f11f8771ef07308ee](https://github.com/compodoc/compodoc/commit/c80d15519e8bfa07625ba72f11f8771ef07308ee)), closes [#419](https://github.com/compodoc/-compodoc/issues/419)
+* **dependencies:** optional field in parameter table could be yes or no ([96f3a0b1c9d3d00fde7a21afddde525619c4a39b](https://github.com/compodoc/compodoc/commit/96f3a0b1c9d3d00fde7a21afddde525619c4a39b)), closes [#420](https://github.com/compodoc/-compodoc/issues/420)
+* **dependencies:** @link to all miscellaneous ([0194c1b78cb64b6f6b705e3af4072698f21d8f34](https://github.com/compodoc/compodoc/commit/0194c1b78cb64b6f6b705e3af4072698f21d8f34)), closes [#416](https://github.com/compodoc/-compodoc/issues/416)
+* **dependencies:** shorthand metadatas support for components/directives ([295a029e69011ab8346dd12be7284809291d1638](https://github.com/compodoc/compodoc/commit/295a029e69011ab8346dd12be7284809291d1638)), closes [#407](https://github.com/compodoc/-compodoc/issues/407)
+* **dependencies:** useExisting support for interceptors ([7c8794a](https://github.com/compodoc/compodoc/commit/7c8794a)), closes [#406](https://github.com/compodoc/-compodoc/issues/406)
+* **search:** prevent lunr call stack size exceeded for huge file ([f495cd](https://github.com/compodoc/compodoc/commit/f495cd)), closes [#410](https://github.com/compodoc/-compodoc/issues/410) [#378](https://github.com/compodoc/-compodoc/issues/378)
+* **core:** add package-lock.json ([15ce12c8fc47be929865a21a8131ab035e8c80ae](https://github.com/compodoc/compodoc/commit/15ce12c8fc47be929865a21a8131ab035e8c80ae)), closes [#413](https://github.com/compodoc/-compodoc/issues/413)
+* **core:** rollback to marked ([c5eb16d99057bdbfdf7c134b3613d8d0266c882d](https://github.com/compodoc/compodoc/commit/c5eb16d99057bdbfdf7c134b3613d8d0266c882d)), closes [#349](https://github.com/compodoc/-compodoc/issues/349)
+* **core:** bump dependencies ([99be40081ce51bd636ef38eb4b21788621f09e70](https://github.com/compodoc/compodoc/commit/99be40081ce51bd636ef38eb4b21788621f09e70)), closes [#430](https://github.com/compodoc/-compodoc/issues/430)
+* **routing:** spread & dynamic value first support ([47fd133136903efe2f4148b93cafc53fd104e92c](https://github.com/compodoc/compodoc/commit/47fd133136903efe2f4148b93cafc53fd104e92c)), closes [#452](https://github.com/compodoc/-compodoc/issues/452)
+* **routing:** recursive dynamic variable support ([5a98b56e15da9040d5bdac967408f49a526b46bc](https://github.com/compodoc/compodoc/commit/5a98b56e15da9040d5bdac967408f49a526b46bc)), closes [#417](https://github.com/compodoc/-compodoc/issues/417) [#400](https://github.com/compodoc/-compodoc/issues/400) [#394](https://github.com/compodoc/-compodoc/issues/394) [#361](https://github.com/compodoc/-compodoc/issues/361) [#364](https://github.com/compodoc/-compodoc/issues/364) [#459](https://github.com/compodoc/-compodoc/issues/459)
+* **routing:** support for ModuleWithProviders definition ([dbdb6a61736cc97943fd5ea22ed20be5c4228974](https://github.com/compodoc/compodoc/commit/dbdb6a61736cc97943fd5ea22ed20be5c4228974)), closes [#257](https://github.com/compodoc/-compodoc/issues/257)
+* **routing:** scan also static value in class ([26dd154de242796737bbb2239c5b4e4e9e2e4bf2](https://github.com/compodoc/compodoc/commit/26dd154de242796737bbb2239c5b4e4e9e2e4bf2)), closes [#394](https://github.com/compodoc/-compodoc/issues/394)
+* **coverage:** src folder not parsed ([7b32ac67debe9fc90047db4fd4a285336d3391d5](https://github.com/compodoc/compodoc/commit/7b32ac67debe9fc90047db4fd4a285336d3391d5)), closes [#431](https://github.com/compodoc/-compodoc/issues/431)
+* **template:** Removed relative URL helper function from logo img tag ([3f18d0c7f51054f8d2c962a782e1dfdf0207d061](https://github.com/compodoc/compodoc/commit/3f18d0c7f51054f8d2c962a782e1dfdf0207d061))
+Thanks [ainsleybc](https://github.com/ainsleybc)
+* **template:** Fixing ordered lists in README.md files ([bf227874266a1e29647128f061dc099ab8ae3c21](https://github.com/compodoc/compodoc/commit/bf227874266a1e29647128f061dc099ab8ae3c21)), closes [#435](https://github.com/compodoc/-compodoc/issues/435)
+Thanks [Michael Letcher](https://github.com/michael-letcher)
+
 <a name="1.0.5"></a>
 # [1.0.5](https://github.com/compodoc/compodoc/compare/1.0.4...1.0.5) (2017-12-02)
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,12 +24,12 @@ See this folder for more details : [DOCS](./docs/README.md)
 
 ### Development process
 
-- open one terminal and run inside compodoc folder : `ǹpm run start`
+- open one terminal and run inside compodoc folder : `npm run start`
 - open another terminal with the source code of the [demo project](https://github.com/compodoc/compodoc-demo-todomvc-angular), and run `compodoc -p src/tsconfig.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc --toggleMenuItems 'all'" -s`
 
 ### Debugging process
 
-- open one terminal and run inside compodoc folder : `ǹpm run start`
+- open one terminal and run inside compodoc folder : `npm run start`
 - open another terminal with the source code of the [demo project](https://github.com/compodoc/compodoc-demo-todomvc-angular), and run `node --inspect ../compodoc/bin/index-cli.js -p src/tsconfig.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc --toggleMenuItems 'all'" -s`
 
 ## <a name="issue"></a> Found an Issue?
@@ -231,14 +231,44 @@ Just as in the **subject**, use the imperative, present tense: "change" not Ther
 * **changelog**: used for updating the release notes in CHANGELOG.md
 * none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
 
-There are currently a few exceptions to the "use package name" rule:
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
 
-* **packaging**: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
-* **changelog**: used for updating the release notes in CHANGELOG.md
-* none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
+A detailed explanation can be found in this [document][commit-message-format].
 
 
+## Financial contributions
 
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/compodoc).
+Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
 
-A detailed explanation can be found in this [document][commit-message-format].
+
+## Credits
+
+
+### Contributors
+
+Thank you to all the people who have already contributed to compodoc!
+<a href="graphs/contributors"><img src="https://opencollective.com/compodoc/contributors.svg?width=890" /></a>
+
+
+### Backers
+
+Thank you to all our backers! [[Become a backer](https://opencollective.com/compodoc#backer)]
+
+<a href="https://opencollective.com/compodoc#backers" target="_blank"><img src="https://opencollective.com/compodoc/backers.svg?width=890"></a>
+
+
+### Sponsors
+
+Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/compodoc#sponsor))
+
+<a href="https://opencollective.com/compodoc/sponsor/0/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/1/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/2/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/3/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/4/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/5/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/6/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/7/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/8/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/compodoc/sponsor/9/website" target="_blank"><img src="https://opencollective.com/compodoc/sponsor/9/avatar.svg"></a>
diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@
   <a href="https://david-dm.org/compodoc/compodoc"><img src="https://david-dm.org/compodoc/compodoc.svg" alt="npm dependencies"></a>
   <a href="https://david-dm.org/compodoc/compodoc?type=dev"><img src="https://david-dm.org/compodoc/compodoc/dev-status.svg" alt="npm devDependencies"></a>
   <a href="http://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"></a>
+  <a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/compodoc/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/compodoc/sponsors/badge.svg" />
 </p>
 <p align="center">
     <img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge">
@@ -70,6 +71,18 @@ Official documentation has moved to [https://compodoc.github.io/website/](https:
 
 Ready to get started? [Read installation instructions](https://compodoc.github.io/website/guides/installation.html).
 
+# Backers
+
+Support us with a monthly donation and help us continue our activities. [Become a backer][support-url]
+
+[![Backers][backers-image]][support-url]
+
+# Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor][support-url]
+
+[![Sponsors][sponsors-image]][support-url]
+
 # Contributing
 
 Want to file a bug, contribute some code, or improve documentation? Excellent!
@@ -86,7 +99,12 @@ Read up on our guidelines for [contributing](https://github.com/compodoc/compodo
 
 Everything in this repository is [licensed under the MIT License][license] unless otherwise specified.
 
-Copyright (c) 2016–2017 [Vincent Ogloblinsky]
+Copyright (c) 2016 – 2018 [Vincent Ogloblinsky]
 
 [license]: https://github.com/compodoc/compodoc/blob/master/LICENSE
 [Vincent Ogloblinsky]: http://www.vincentogloblinsky.com
+
+
+[support-url]: https://opencollective.com/compodoc#support
+[backers-image]: https://opencollective.com/compodoc/backers.svg
+[sponsors-image]: https://opencollective.com/compodoc/sponsors.svg
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,22 @@
 # Compodoc architecture and operating
 
+## Libraries used inside generate static HTML pages
+
+- bootstrap native : 1.1.0
+- d3 from d3-flextree : 3.x.x
+- deep-iterator : 2.4.0
+- es6-shim : 0.35.1
+- EventDispatcher
+- htmlparser : 2.0.0
+- innersvg : 2.x.x
+- prism : 1.9.0
+- promise
+- svg-pan-zoom : 3.5.2
+- tablesort : 5.0.2
+- vis : 4.20.1
+- zepto : 1.2.0
+- lunr : 2.1.5
+
 ## Entry files
 
 If you are using Compodoc in module mode with a JavaScript file, require('@compodoc/compodoc'), the first entry file is `src/index.ts`.
@@ -16,3 +33,35 @@ The process of Compodoc is :
 - generate all the internal stuff
 - emit files for each category (modules, components, etc)
 - echo the result of the generation.
+
+## Testing
+
+Unit testing is done by running severals documentation generation with many different files and projects.
+
+E2E testing id done with saucelabs service.
+
+### Local unit testing
+
+> npm run test
+
+### Local E2E
+
+1. install selenium-standalone (https://www.npmjs.com/package/selenium-standalone)
+
+> npm install selenium-standalone@latest -g
+
+2. configure selenium-standalone
+
+> selenium-standalone install
+
+3. start selenium-standalone
+
+> selenium-standalone start
+
+4. start local documentation generation in another terminal tab 
+
+> npm run test:simple-doc
+
+5. start local E2E testing
+
+> npm run local-test-e2e-mocha
diff --git a/docs/TODOS.md b/docs/TODOS.md
@@ -0,0 +1,12 @@
+## TypeScript errors to fix
+
+- code-generator.ts
+- dependencies.ts
+- class-helper.visitType.spec.ts
+- class-helper.ts
+- component-helper.ts
+- js-doc-helper.ts
+- symbol-helper.ts
+- dependencies.engine.ts
+- jsdoc-parser.util.ts
+- router-parser.util.ts