Installations

npm install @types/changelog-parser

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Pull Requests

Open

159

Total

60,614

Closed

9,563

Merged

50,892

Issues

Open

560

Total

8,070

Closed

7,510

Releases

1

0.1.450

Published on 04 Sept 2019

View all 1 releases

Contributors

9,977

View all 9,977 contributors

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.9%)

JavaScript (0.09%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

561,665

Last Day

1,630

Last Week

8,628

Last Month

28,256

Last Year

208,965

GitHub Statistics

49,092 Stars

88,623 Commits

30,287 Forks

640 Watching

5 Branches

9,977 Contributors

Maintainers

1

Package Meta Information

Latest Version

2.8.4

Package Id

@types/changelog-parser@2.8.4

Unpacked Size

6.03 kB

Size

2.17 kB

File Count

5

Publised On

07 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

561,665

Last day

-18.5%

1,630

Compared to previous day

Last week

19.6%

8,628

Compared to previous week

Last month

53.3%

28,256

Compared to previous month

Last year

16.4%

208,965

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Installation

npm install --save @types/changelog-parser

Summary

This package contains type definitions for changelog-parser (https://github.com/hypermodules/changelog-parser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/changelog-parser.

index.d.ts

1// Options must contain exactly one of filePath or text. This can be expressed
2// with a type, but not an interface. (See
3// <https://github.com/osteele/vscode-p5server/blob/fee241c06f/scripts/types/changelog-parser.d.ts>,
4// which contains the ambient interface that this type was extracted from.)
5//
6// The DefinitelyTyped lint settings don't allow type literals, so define an
7// interface here, and use it to construct a type expression in the argument.
8
9declare namespace parseChangelog {
10    interface Options {
11        /**
12         * Path to changelog file.
13         */
14        filePath: string;
15        /**
16         * Text of changelog file (you can use this instead of filePath).
17         */
18        text: string;
19        /**
20         * Removes the markdown markup from the changelog entries by default.
21         * You can change its value to false to keep the markdown.
22         */
23        removeMarkdown: boolean;
24    }
25
26    interface Changelog {
27        title: string;
28        description: string;
29        versions: Array<{
30            version: string | null;
31            title: string;
32            date: string | null;
33            body: string;
34            parsed: Record<string, string[]>;
35        }>;
36    }
37}
38
39/**
40 * Change log parser for node.
41 */
42// The implementation returns a Promise whether or not a callback is specified.
43// This type declaration reflects this.
44declare function parseChangelog(
45    options:
46        | (
47            & Partial<Exclude<parseChangelog.Options, "filePath" | "text">>
48            & (Pick<parseChangelog.Options, "filePath"> | Pick<parseChangelog.Options, "text">)
49        )
50        | string,
51    callback?: (error: string | null, result: parseChangelog.Changelog) => void,
52): Promise<parseChangelog.Changelog>;
53
54export = parseChangelog;
55

Additional Details

Last updated: Mon, 06 Nov 2023 22:41:05 GMT
Dependencies: none

Credits

These definitions were written by Oliver Steele.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More