CHANGELOG.md

ChangeLog

0.4.14 5 March 2021

Chore release - updating dependencies

0.4.13 11 January 2021

fix(Dgeni): do not print stack trace on error unless debugging (a3c870d)

0.4.12 14 March 2019

Chore release - updating dependencies

0.4.11 17 December 2018

Chore release - updating TypeScript dependency

0.4.10 14 August 2018

Chore release - updating dependencies

0.4.9 15 June 2017

Chore release

0.4.8 15 June 2017

• fix(processor): add missing fields to Processor type definition b4ed72f0

0.4.7 15 February 2017

• fix(mocks): ensure mock logger is available in the published package ca43a807

v0.4.6 (14th February 2017)

• fix(Dgeni): ensure that the typings are exposed correctly a0fc03c9

v0.4.5 (14th February 2017)

False start!

v0.4.4 (13th February 2017)

Minor docs and chores updates; in particular the @types/mocha dependency was moved to devDependencies to prevent unwanted leakage into client projects.

v0.4.3 (12th February 2017)

Various docs and refactorings including a complete rewrite in typescript, which enables API typings for TypeScript users.

v0.4.2 (6th January 2016)

Node dependency update - dgeni now cleanly support node 4 and 5 (and so npm 3)

v0.4.1 (4th October 2014)

Minor Bug Fix

• fix(Package): allow use of npm link with dgeni 6698fe9f

v0.4.0 (10th September 2014)

Major New Release

This is a major re-architecting from v0.3.0 of how Dgeni uses Dependency Injection and configuration.

This version of Dgeni is compatible with dgeni-packages v0.10.0

• Dgeni is now configured by Packages, which can depend on other Packages. You create an instance of Dgeni, passing in the Packages that are to be loaded.

• Packages contain Services, Processors and Config Blocks, which are all instantiated or invoked by the DI system.

• Dgeni specific properties on Processors are now prefixed with a $. E.g. $process(), $runBefore, $runAfter.

• Processors themselves are special instances of DI Services. In the previous versions of dgeni the process() method was being invoked by the DI system instead. Now since the processor itself is created by a factory function that can be injected with Services, much more can be done to configure the Processor before the $process(docs) method is called.

• Processors can now be "validated" using validatejs.org constraints, specified in the processor.$validate property.

• Processors can now be disabled by setting processor.$enabled = false.

• Services and Processors with the same name will override previously registered ones, say from a Package dependency. This enables custom Packages to provide alternate components and makes mocking much easier in tests.

• New injectable helper services have been provided: dgeni, log, getInjectables.

• Each instance of Dgeni now exposes a configureInjector() method, which returns the configured dgeni DI injector. This is useful in unit testing to easily get access to the Services and Processors to be tested.

• Now use the injectable log service in your Processors and Services instead of requiring winston. This also means that it is easier to replace the logger implementation both in the future and for testing. Dgeni provides a "mock" logger at dgeni/lib/mocks/log, which you can require to override the standard winston logger.

• Test coverage of the source files is now at 100%.

v0.4.0-rc.2 (10th September 2014)

Minor refactoring

• chore(tests): move tests into lib folder 607037fe

v0.4.0-rc.1 (6th September 2014)

Minor refactoring

• fix(Dgeni): handle validation and processor errors better b452b472

v0.4.0-beta.4 (1st September 2014)

Minor refactoring and fixes

• feat(Dgeni): add configureInjector method 6a37dada
• fix(gen-docs.js): remove unnecessary reference to base package b7d7185e
• feat(gen-docs): add log option to CLI 062ca137
• fix(gen-docs.js): startsWith() is not ES5 compatible 22e11630

v0.4.0-beta.3 (12th August 2014)

Minor refactoring

• refact(Dgeni): remove dependency on 'es6-shim' and Map a8fa07eb

v0.4.0-beta.2 (7th August 2014)

Minor bug fixes

• fix(Dgeni): require Package not package fc2be818
• fix(Dgeni): do not modify package.dependencies property 61449389

v0.4.0-beta.1 (25th July 2014)

This is a major re-architecting of how Dgeni uses Dependency Injection and configuration.

This version of Dgeni is compatible with dgeni-packages@^0.10.0

• Dgeni is now configured by Packages, which can depend on other Packages.
• Packages contain Services, Processors and Config Blocks, which are all instantiated or invoked by the DI system.
• Processors themselves are special instances of DI Service rather than the process() being invoked by the DI system.
• Dgeni specific properties on Processors are now prefixed with a $. E.g. $process(), $runBefore, $runAfter.
• Processors can now be "validated" using validatejs.org constraints, specified in the processor.$validate property.
• Processors can now be disabled by setting processor.$enabled = false.
• Processors with the same name will override previously registered Processors, say from a Package dependency.
• New injectable helper services have been provided: dgeni, log, getInjectables.
• Use injectable log service in your Processors and Services instead of requiring winston.
• Test coverage of the source files is now at 100%.

The most significant commits are listed below:

• fix(Dgeni): allow config blocks to change $enabled on a Processor d231c244
• feat(Dgeni): allow processors to be disabled by setting $enabled: false d390fcd3
• feat(Dgeni): allow config blocks to make changes to processor order 604fcbfb
• feat(Dgeni): add package info to processors to help with error reporting 81184052
• fix(Dgeni): processors with the same name should override previous ones ff7ec049
• feat(getInjectables): add new shared service 6d9cef0a
• test(mock/log): add simple mock log service for testing 51a8dc92
• feat(Package): allow processors and service to override their name a9584fd2
• test(Dgeni): add tests to improve code coverage 7b4a757b
• feat(Package): allow processors to be defined as an object a75e9181
• feat(Dgeni): add new (no config - DI based) Dgeni e8d30958
• feat(Package): add Package type 87cbf122
• feat(log): add wrapper around winston c303a9a6
• refact(*): remove previous Dgeni implementation 1cf67e2d

v0.3.0 (11th April 2014)

This is a "Spring Clean" release

• Configuration, utilities and dependencies that were only used by separate Dgeni packages have been moved to those repositories.
• There is an initial set of "guide" documents to read at https://github.com/angular/dgeni/tree/master/docs/en_GB/guide.
• The API has been cleaned up to make it easier to use Dgeni without having to look inside.

New Stuff

• feat(doc-processor): processors can declare injectable exports cfd19f08

Breaking Changes

• refactor(index): provide a cleaner API surface 3c78776d
• refact(doc-processor): move pseudo processors to dgeni-packages c198f651

v0.2.2 (6th March 2014)

Bug fixes

• fix(doc-processor): pass docs to next processor following a failure 67997e8e

v0.2.1 (5th March 2014)

Bug fixes

• fix(doc-processor): handle errors thrown in processors better

v0.2.0 (28th February 2014)

New Features

• extractTagFactory (lib/extract-tags.js) is moved to the dgeni-packages project.

BREAKING CHANGE

• The extractTagsFactory is now moved to the dgeni-packages project, because it is specific to the way that tags are parsed and extracted in that project. If you rely on this then you should add dgeni-packages as a dependency to your project.

v0.1.1 (24th February 2014)

Bug fixes

• allow defaultFn to return falsy values 3b2e098dc92b

v0.1.0 (20th February 2014)

• Initial version to support AngularJS documentation generation.