es-utils

Shared JavaScript utilities for Blocks and EntryScape.

Extracts and consolidates common functionality used across both projects to reduce duplication and ensure consistency.

Installation

pnpm add @entryscape/es-utils

Usage

import { merge, fetchJson, EntityType } from '@entryscape/es-utils';

Formats

@entryscape/es-utils/formats maps EU file-type codes to IANA media types and gives display labels for distribution formats. It is the only entry point that also works in plain Node, as ESM or CommonJS:

import { getFormatLabel, ianaToNal } from '@entryscape/es-utils/formats';
const { readFormat } = require('@entryscape/es-utils/formats');

See src/formats/README.md.

Development

pnpm test         # Run tests
pnpm lint         # Run linter
pnpm lint-fix     # Auto-fix lint issues
pnpm lint-n-test  # Run linter and tests
pnpm refresh      # Clean reinstall and test
pnpm build        # Build the CommonJS bundle of the formats module (dist/)
pnpm check:package  # Build, then check that the formats module loads via require and import
pnpm generate:formats  # Regenerate the file-type mapping from the EU vocabulary

Releasing

The release script bumps the version, updates the changelog with Jira issues, runs lint and tests, commits, tags, and pushes to origin.

Setup

Set up Jira API credentials:

export JIRA_EMAIL="[email protected]"
export JIRA_API_TOKEN="your-api-token"

Get your API token from: https://id.atlassian.com/manage-profile/security/api-tokens

Usage

pnpm release              # Patch release (1.0.0 -> 1.0.1)
pnpm release minor        # Minor release (1.0.0 -> 1.1.0)
pnpm release major        # Major release (1.0.0 -> 2.0.0)
pnpm release --dry-run    # Preview without making changes

What it does

1. Bumps version in package.json
2. Collects Jira issues from merge commits since the last tag
3. Filters issues to only include those with the es-utils component
4. Updates CHANGELOG.md with the new release entry
5. Runs pnpm lint-n-test
6. Commits changes with message "release version X.Y.Z"
7. Creates a git tag
8. Pushes commit and tag to origin

The script does not publish. pnpm pack and pnpm publish build dist/ and run pnpm check:package first, through the prepack script.