2.16.3 • Published 2 months ago

@nestjs-mod/reports v2.16.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

@nestjs-mod/reports

Modules and utilities for generating reports on infrastructure and features

NPM version monthly downloads Telegram Discord

Installation

npm i --save @nestjs-mod/reports

Modules

LinkCategoryDescription
NestjsModAllReadmeGeneratorinfrastructureReadme generator for nestjs-mod modules.

Modules descriptions

NestjsModAllReadmeGenerator

Readme generator for nestjs-mod modules.

Use in NestJS-mod

Example of use with all need options.

import { bootstrapNestApplication } from '@nestjs-mod/common';
import { NestjsModAllReadmeGenerator } from '@nestjs-mod/reports';
import { join } from 'path';

const libFolder = join(__dirname, '..', '..', '..', 'libs/common');

bootstrapNestApplication({
  modules: {
    infrastructure: [
      NestjsModAllReadmeGenerator.forRoot({
        contextName: 'common',
        staticConfiguration: {
          telegramGroup: 'https://t.me/nestjs_mod',
          discord:'https://discord.gg/meY7UXaG',
          packageFile: join(libFolder, 'package.json'),
          markdownFile: join(libFolder, 'README.md'),
          folderWithMarkdownFilesToUse: libFolder,
          utilsFolders: [join(libFolder, 'src/lib')],
          modules: [import('@nestjs-mod/common')],
          markdownFooter: `
## Links

* https://github.com/nestjs-mod/nestjs-mod - A collection of utilities for unifying NestJS applications and modules
* https://github.com/nestjs-mod/nestjs-mod-contrib - Contrib repository for the NestJS-mod
`,
        },
      }),
    ],
  },
});

Static configuration

KeyDescriptionConstraintsDefaultValue
utilsFoldersFolders with utilitiesisNotEmpty (utilsFolders should not be empty)--
modulesNodeJS modules with NestJS-mod modulesisNotEmpty (modules should not be empty)-hidden
packageFileName of the package.json file with informationisNotEmpty (packageFile should not be empty)--
markdownFileName of the markdown file in which to saveisNotEmpty (markdownFile should not be empty)--
folderWithMarkdownFilesToUseA folder of markdown files with instructions for using modules in NestJS and NestJS-mod applications (example of file names: /libs/reports/NESTJS_MOD_ALL_README_GENERATOR_USE_IN_NEST_JS.md, /libs/reports/NESTJS_MOD_ALL_README_GENERATOR_USE_IN_NEST_JS_MOD.md)optional--
markdownHeaderCustom header markdown stringoptional--
markdownFooterCustom footer markdown stringoptional--
telegramGroupTelegram groupoptional--
discordDiscordoptional--

Back to Top

Links

License

MIT

2.16.3

2 months ago

2.16.1

3 months ago

2.16.2

3 months ago

2.16.0

3 months ago

2.15.0

3 months ago

2.14.1

5 months ago

2.14.2

4 months ago

2.14.0

5 months ago

2.13.4

8 months ago

2.13.2

8 months ago

2.13.3

8 months ago

2.13.0

8 months ago

2.13.1

8 months ago

2.12.10

8 months ago

2.12.9

9 months ago

2.12.8

10 months ago

2.12.7

10 months ago

2.12.6

10 months ago

2.12.5

10 months ago

2.12.4

10 months ago

2.12.0

10 months ago

2.12.3

10 months ago

2.12.1

10 months ago

2.12.2

10 months ago

2.11.2

10 months ago

2.11.1

10 months ago

2.11.0

10 months ago

2.10.0

10 months ago

2.9.2

10 months ago

2.9.1

10 months ago

2.9.0

11 months ago

2.7.0

11 months ago

2.8.0

11 months ago

2.6.3

11 months ago

2.6.2

11 months ago

2.6.1

11 months ago

2.6.0

11 months ago

2.5.3

11 months ago

2.5.2

11 months ago

2.5.1

11 months ago

2.5.0

11 months ago

2.3.0

11 months ago

2.2.0

11 months ago

2.4.1

11 months ago

2.4.0

11 months ago

2.3.1

11 months ago

2.0.2

11 months ago

2.1.0

11 months ago

2.0.1

11 months ago

2.0.0

11 months ago

1.10.0

11 months ago

1.9.1

11 months ago

1.9.0

11 months ago

1.8.0

11 months ago

1.9.2

11 months ago

1.7.2

11 months ago

1.7.1

11 months ago

1.7.0

11 months ago

1.6.1

11 months ago

1.6.0

11 months ago

1.5.4

12 months ago

1.5.3

12 months ago

1.5.2

12 months ago

1.5.1

12 months ago

1.5.0

12 months ago

1.4.0

12 months ago

1.3.0

12 months ago

1.2.0

12 months ago

1.1.0

12 months ago

1.0.0

12 months ago