Registry / testing / gitlint-parser-base

gitlint-parser-base

library2.0.0jsnpmunverified

gitlint-parser-base is a foundational utility package providing the core parsing logic for the `gitlint` ecosystem. As of version 2.0.0, it exports a `Parser` class and a `createContext` function, enabling structured extraction of header, body, and footer components from raw Git commit messages. This package primarily serves as an internal dependency for the main `gitlint` project and other related tools that require a standardized way to interpret commit message structure. Its release cadence is closely tied to the `gitlint` project's evolution, with updates driven by changes in Git message parsing requirements or internal architectural enhancements. It is designed to be a building block for linting and analysis, rather than a standalone, general-purpose text parser, specializing in the nuances of Git commit conventions.

testing devops

npm install gitlint-parser-base

github ↗package ↗

INSTALL

IMPORT

SIG · GITLINT-PARSER-BAS

gitlint-parser-base

testingjavascriptv2.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Parser

✓ const { Parser } = require('gitlint-parser-base');

✗ import { Parser } from 'gitlint-parser-base';

This package is a CommonJS module. Direct ESM `import` is not supported without a transpiler or dynamic `import()`.

createContext

✓ const { createContext } = require('gitlint-parser-base');

✗ import { createContext } from 'gitlint-parser-base';

Used internally by the `Parser` class, but can be accessed directly for custom context handling or testing. It is a CommonJS export.

Demonstrates how to import the `Parser` class, instantiate it with a commit message, and then parse the message to access its structural components like header, body, and footer.

const { Parser } = require('gitlint-parser-base'); const commitMessage = `feat(parser): add base parser for gitlint\n\nThis commit introduces the foundational parser for gitlint.\nIt extracts header, body, and footer from a commit message.\n\nFixes #123\nRefs #456`; try { const parser = new Parser(commitMessage); const parsed = parser.parse(); console.log('Header:', parsed.header); console.log('Body:', parsed.body); console.log('Footer:', parsed.footer); // Example of accessing parsed header properties (assuming parseHeader populates them) if (parsed.header && typeof parsed.header === 'object') { console.log('Header type (scope):', parsed.header.type, parsed.header.scope); } } catch (error) { console.error('Error parsing commit message:', error.message); }

Debug

Known issues

gotchaThe `gitlint-parser-base` package is distributed as a CommonJS module. Attempting to use `import { Parser } from 'gitlint-parser-base';` in an ESM context will result in a syntax error or runtime error.

fix

Use CommonJS `require` syntax: `const { Parser } = require('gitlint-parser-base');` or use dynamic `import()` if truly in an ESM context: `const { Parser } = await import('gitlint-parser-base');`.

affects: >=1.0.0

breakingVersion 2.0.0 introduced significant internal changes to how parsing is handled, potentially affecting consumers who were relying on internal or undocumented APIs from version 1.x. The public API surface (Parser class, createContext) has been stabilized, but direct access to internal modules or properties may behave differently.

fix

Review your code for reliance on undocumented internals. Upgrade carefully and test thoroughly, ensuring only the documented `Parser` class and `createContext` function are utilized.

affects: >=2.0.0

gotchaThe `Parser` class requires a raw commit message string in its constructor. Passing malformed input or non-string values may lead to unexpected parsing results or errors, as it expects a specific Git commit message format.

fix

Always provide a valid string representing a Git commit message to the `Parser` constructor. Implement input validation before instantiation to handle edge cases gracefully.

affects: >=1.0.0

gotchaThis package is primarily intended as a base utility for `gitlint`. While usable independently, it does not include any linting rules or validation logic itself. It only provides the structural parsing.

fix

If full linting capabilities are required, use the main `gitlint` package. This package is suitable for scenarios where only structural decomposition of commit messages is needed.

affects: >=1.0.0

Errors

Common errors & fixes

SyntaxError: Named export 'Parser' not found. The requested module 'gitlint-parser-base' does not provide an export named 'Parser'

Attempting to use ESM `import { Parser } from 'gitlint-parser-base';` with a CommonJS-only package.

fix

Change the import statement to CommonJS `require`: `const { Parser } = require('gitlint-parser-base');`.

TypeError: Parser is not a constructor

Attempting to call `new Parser()` after incorrect import (e.g., `const Parser = require('gitlint-parser-base').Parser;` or an invalid default import).

fix

Ensure you are destructuring the `Parser` class correctly from the CommonJS `module.exports`: `const { Parser } = require('gitlint-parser-base');`

TypeError: Cannot read properties of undefined (reading 'type') at Parser.parse (index.js:XX:YY)

This error can occur if the commit message provided to the `Parser` constructor is `null`, `undefined`, or an empty string, leading to subsequent internal operations failing to access properties on the expected message content.

fix

Always provide a non-empty string as the `commitMessage` argument to `new Parser(commitMessage)`. Validate the input before creating a parser instance.

Upgrade

Version history

2.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/evanlucas/gitlint-parser-base ↗

packagehttps://www.npmjs.com/package/gitlint-parser-base ↗