Skip to content

Latest commit

 

History

History
205 lines (142 loc) · 4.85 KB

CHANGELOG.md

File metadata and controls

205 lines (142 loc) · 4.85 KB
Raw

Changelog

Tags:

  • [New Feature]
  • [Bug Fix]
  • [Breaking Change]
  • [Documentation]
  • [Internal]
  • [Polish]
  • [Experimental]

Note: Gaps between patch versions are faulty/broken releases. Note: A feature tagged as Experimental is in a high state of flux, you're at risk of it changing without notice.

0.8.0

  • update fp-ts version
  • simplify Config module
  • remove Settings
  • add tsconfig.json to examples folder when type checking examples
  • split compilerOptions in config to:
    • parseCompilerOptions
    • examplesCompilerOptions

0.7.2

remove extensions from examples/index.ts

0.7.1

make docs-ts compatible with typescript ^5.x

0.7.0

  • New Feature
    • add compilerOptions to configuration (@gcanti)

0.6.10

  • Bug Fix
    • fix Parser ignoring @internal/@ignored methods on classes (@IMax153)

0.6.9

  • Polish
    • print error as non coerced string, #28 (@waynevanson)

0.6.8

  • Polish
    • modules no longer require examples when enforceExamples is true (@IMax153)

0.6.7

  • Bug Fix
    • use strict: true in project configuration, fix #36 (@gcanti)

0.6.6

  • Bug Fix
    • simplify @example import replacement, #35 (@thought2)

0.6.5

  • Polish
    • allow double quotes in @example project imports, #31 (@thought2)

0.6.4

  • New Feature
    • add projectHomepage configuration property, closes #26 (@IMax153)

0.6.3

  • Polish
    • fix modules not respecting config settings #24 (@IMax153)
    • move prettier to peerDependencies, closes #22 (@gcanti)

0.6.2

  • Breaking Change

    • refactor Markdown module (@IMax153)
      • add Markdown constructors (@IMax153)
      • add tagged union of Printable types (@IMax153)
      • add fold destructor for Markdown (@IMax153)
      • add Semigroup, Monoid, and Show instances for Markdown (@IMax153)
      • add printModule helper function (@IMax153)
    • update Parser module (@IMax153)
      • add ParserEnv which extends Environment (@IMax153)
      • add Ast interface (@IMax153)
    • update Core module (@IMax153)
      • add Program and Environment types (@IMax153)
      • update Capabilities interface (@IMax153)
      • remove Eff, MonadFileSystem, and MonadLog types (@IMax153)
      • remove MonadFileSystem and MonadLog instances (@IMax153)
    • rename domain module to Module (@IMax153)
      • rename all constructors to match their respective types (@IMax153)

  • New Feature

    • add Config module (@IMax153)
      • support configuration through docs-ts.json file (@IMax153)
      • add Config, ConfigBuilder and Settings types (@IMax153)
      • add build constructor ConfigBuilder (@IMax153)
      • add resolveSettings destructor for creating Settings from a ConfigBuilder (@IMax153)
      • add combinators for manipulating a ConfigBuilder (@IMax153)
    • add FileSystem module (@IMax153)
      • add FileSystem instance (@IMax153)
      • add File constructor (@IMax153)
      • add exists, readFile, remove, search, and writeFile helper functions (@IMax153)
    • add Logger module (@IMax153)
      • add LogEntry, LogLevel, and Logger types (@IMax153)
      • add showEntry and Logger instances (@IMax153)
      • add debug, error, and info helper functions (@IMax153)
    • Add Example module (@IMax153)
      • add run helper function (@IMax153)

0.5.3

  • Polish
    • add support for TypeScript 4.x, closes #19 (@gcanti)

0.5.2

  • Polish
    • use ts-node.cmd on windows, #15 (@mattiamanzati)

0.5.1

  • Bug Fix
    • should not return ignore function declarations (@gcanti)
    • should not return internal function declarations (@gcanti)
    • should output the class name when there's an error in a property (@gcanti)

0.5.0

  • Breaking Change
    • total refactoring (@gcanti)

0.4.0

  • Breaking Change
    • the signature snippets are not valid TS (@gcanti)
    • add support for class properties (@gcanti)

0.3.5

  • Polish
    • support any path in src in the examples, #12 (@gillchristian)

0.3.4

  • Polish
    • remove code from headers (@gcanti)

0.3.3

  • Polish
    • remove useless postfix (@gcanti)

0.3.1

  • Bug Fix
    • add support for default type parameters (@gcanti)

0.3.0

  • Breaking Change
    • modules now can/must be documented as usual (@gcanti)
      • required @since tag
      • no more @file tags (descriptione can be specified as usual)

0.2.1

  • Internal
    • run npm audit fix (@gcanti)

0.2.0

  • Breaking Change
    • replace ts-simple-ast with ts-morph (@gcanti)
    • make @since tag mandatory (@gcanti)
  • New Feature
    • add support for ExportDeclarations (@gcanti)

0.1.0

upgrade to fp-ts@2.0.0-rc.7 (@gcanti)

  • Bug Fix
    • fix static methods heading (@gcanti)

0.0.3

upgrade to fp-ts@1.18.x (@gcanti)

0.0.2

  • Bug Fix
    • fix Windows Path Handling (@rzeigler)

0.0.1

Initial release