relion 0.2.0 → 0.3.0

package/src/lib/updaters/index.js

@@ -1,130 +0,0 @@
-import path from 'path'
-import defaults from '../../defaults.js'
-import * as jsonUpdater from './types/json.js'
-import * as plainTextUpdater from './types/plain-text.js'
-import * as mavenUpdater from './types/maven.js'
-import * as gradleUpdater from './types/gradle.js'
-import * as csprojUpdater from './types/csproj.js'
-import * as yamlUpdater from './types/yaml.js'
-import * as openapiUpdater from './types/openapi.js'
-import * as pythonUpdater from './types/python.js'
-
-const JSON_BUMP_FILES = defaults.bumpFiles
-const updatersByType = {
-	'json': jsonUpdater,
-	'plain-text': plainTextUpdater,
-	'maven': mavenUpdater,
-	'gradle': gradleUpdater,
-	'csproj': csprojUpdater,
-	'yaml': yamlUpdater,
-	'openapi': openapiUpdater,
-	'python': pythonUpdater,
-}
-const PLAIN_TEXT_BUMP_FILES = ['VERSION.txt', 'version.txt']
-
-function getUpdaterByType(type) {
-	const updater = updatersByType[type]
-	if (!updater) {
-		throw Error(`Unable to locate updater for provided type (${type}).`)
-	}
-	return updater
-}
-
-function getUpdaterByFilename(filename) {
-	if (JSON_BUMP_FILES.includes(path.basename(filename))) {
-		return getUpdaterByType('json')
-	}
-	if (PLAIN_TEXT_BUMP_FILES.includes(filename)) {
-		return getUpdaterByType('plain-text')
-	}
-	if (/pom.xml/.test(filename)) {
-		return getUpdaterByType('maven')
-	}
-	if (/build.gradle/.test(filename)) {
-		return getUpdaterByType('gradle')
-	}
-	if (filename.endsWith('.csproj')) {
-		return getUpdaterByType('csproj')
-	}
-	if (/openapi.yaml/.test(filename)) {
-		return getUpdaterByType('openapi')
-	}
-	if (/\.ya?ml$/.test(filename)) {
-		return getUpdaterByType('yaml')
-	}
-	if (/pyproject.toml/.test(filename)) {
-		return getUpdaterByType('python')
-	}
-	throw Error(
-		`Unsupported file (${filename}) provided for bumping.\n Please specify the updater \`type\` or use a custom \`updater\`.`,
-	)
-}
-
-async function getCustomUpdaterFromPath(updater) {
-	if (typeof updater === 'string') {
-		return (await import(path.resolve(process.cwd(), updater))).default
-	}
-	if (
-		typeof updater.readVersion === 'function'
-		&& typeof updater.writeVersion === 'function'
-	) {
-		return updater
-	}
-	throw new Error('Updater must be a string path or an object with readVersion and writeVersion methods')
-}
-
-/**
- * Simple check to determine if the object provided is a compatible updater.
- */
-function isValidUpdater(obj) {
-	return (
-		obj
-		&& typeof obj.readVersion === 'function'
-		&& typeof obj.writeVersion === 'function'
-	)
-}
-
-export async function resolveUpdaterObjectFromArgument(arg) {
-	/**
-	 * If an Object was not provided, we assume it's the path/filename
-	 * of the updater.
-	 */
-	let updater = arg
-	if (isValidUpdater(updater)) {
-		return updater
-	}
-	if (typeof updater !== 'object') {
-		updater = {
-			filename: arg,
-		}
-	}
-
-	if (!isValidUpdater(updater.updater)) {
-		try {
-			if (typeof updater.updater === 'string') {
-				updater.updater = await getCustomUpdaterFromPath(updater.updater)
-			}
-			else if (updater.type) {
-				updater.updater = getUpdaterByType(updater.type)
-			}
-			else {
-				updater.updater = getUpdaterByFilename(updater.filename)
-			}
-		}
-		catch (err) {
-			if (err.code !== 'ENOENT')
-				console.warn(
-					`Unable to obtain updater for: ${JSON.stringify(arg)}\n - Error: ${err.message
-					}\n - Skipping...`,
-				)
-		}
-	}
-	/**
-	 * We weren't able to resolve an updater for the argument.
-	 */
-	if (!isValidUpdater(updater.updater)) {
-		return false
-	}
-
-	return updater
-}

package/src/lib/updaters/types/csproj.js

@@ -1,13 +0,0 @@
-const versionRegex = /<Version>(.*)<\/Version>/
-
-export function readVersion(contents) {
-	const matches = versionRegex.exec(contents)
-	if (matches === null || matches.length !== 2) {
-		throw new Error('Failed to read the Version field in your csproj file - is it present?')
-	}
-	return matches[1]
-}
-
-export function writeVersion(contents, version) {
-	return contents.replace(versionRegex, `<Version>${version}</Version>`)
-}

package/src/lib/updaters/types/gradle.js

@@ -1,16 +0,0 @@
-const versionRegex = /^version\s+=\s+['"]([\d.]+)['"]/m
-
-export function readVersion(contents) {
-	const matches = versionRegex.exec(contents)
-	if (matches === null) {
-		throw new Error('Failed to read the version field in your gradle file - is it present?')
-	}
-
-	return matches[1]
-}
-
-export function writeVersion(contents, version) {
-	return contents.replace(versionRegex, () => {
-		return `version = "${version}"`
-	})
-}

package/src/lib/updaters/types/json.js

@@ -1,25 +0,0 @@
-import stringifyPackage from '../../stringify-package.js'
-import detectIndent from 'detect-indent'
-import { detectNewline } from 'detect-newline'
-
-export function readVersion(contents) {
-	return JSON.parse(contents).version
-}
-
-export function writeVersion(contents, version) {
-	const json = JSON.parse(contents)
-	const indent = detectIndent(contents).indent
-	const newline = detectNewline(contents)
-	json.version = version
-
-	if (json.packages && json.packages['']) {
-		// package-lock v2 stores version there too
-		json.packages[''].version = version
-	}
-
-	return stringifyPackage(json, indent, newline)
-}
-
-export function isPrivate(contents) {
-	return JSON.parse(contents).private
-}

package/src/lib/updaters/types/maven.js

@@ -1,43 +0,0 @@
-import jsdomPkg from 'jsdom'
-import serialize from 'w3c-xmlserializer'
-import { detectNewline } from 'detect-newline'
-const { JSDOM } = jsdomPkg
-const CRLF = '\r\n'
-const LF = '\n'
-
-function pomDocument(contents) {
-	const dom = new JSDOM('')
-	const parser = new dom.window.DOMParser()
-	return parser.parseFromString(contents, 'application/xml')
-}
-
-function pomVersionElement(document) {
-	const versionElement = document.querySelector('project > version')
-
-	if (!versionElement) {
-		throw new Error('Failed to read the version field in your pom file - is it present?')
-	}
-
-	return versionElement
-}
-
-export function readVersion(contents) {
-	const document = pomDocument(contents)
-	return pomVersionElement(document).textContent
-}
-
-export function writeVersion(contents, version) {
-	const newline = detectNewline(contents)
-	const document = pomDocument(contents)
-	const versionElement = pomVersionElement(document)
-
-	versionElement.textContent = version
-
-	const xml = serialize(document)
-
-	if (newline === CRLF) {
-		return xml.replace(/\n/g, CRLF) + CRLF
-	}
-
-	return xml + LF
-}

package/src/lib/updaters/types/openapi.js

@@ -1,15 +0,0 @@
-import yaml from 'yaml'
-import { detectNewline } from 'detect-newline'
-
-export function readVersion(contents) {
-	return yaml.parse(contents).info.version
-}
-
-export function writeVersion(contents, version) {
-	const newline = detectNewline(contents)
-	const document = yaml.parseDocument(contents)
-
-	document.get('info').set('version', version)
-
-	return document.toString().replace(/\r?\n/g, newline)
-}

package/src/lib/updaters/types/plain-text.js

@@ -1,7 +0,0 @@
-export function readVersion(contents) {
-	return contents
-}
-
-export function writeVersion(_contents, version) {
-	return version
-}

package/src/lib/updaters/types/python.js

@@ -1,30 +0,0 @@
-const versionExtractRegex = /version[" ]*=[ ]*["'](.*)["']/i
-
-const getVersionIndex = function (lines) {
-	let version
-	const lineNumber = lines.findIndex((line) => {
-		const versionMatcher = line.match(versionExtractRegex)
-		// if version not found in lines provided, return false
-		if (versionMatcher == null) {
-			return false
-		}
-		version = versionMatcher[1]
-		return true
-	})
-	return { version, lineNumber }
-}
-
-export function readVersion(contents) {
-	const lines = contents.split('\n')
-	const versionIndex = getVersionIndex(lines)
-	return versionIndex.version
-}
-
-export function writeVersion(contents, version) {
-	const lines = contents.split('\n')
-	const versionIndex = getVersionIndex(lines)
-	const versionLine = lines[versionIndex.lineNumber]
-	const newVersionLine = versionLine.replace(versionIndex.version, version)
-	lines[versionIndex.lineNumber] = newVersionLine
-	return lines.join('\n')
-}

package/src/lib/updaters/types/yaml.js

@@ -1,15 +0,0 @@
-import yaml from 'yaml'
-import { detectNewline } from 'detect-newline'
-
-export function readVersion(contents) {
-	return yaml.parse(contents).version
-}
-
-export function writeVersion(contents, version) {
-	const newline = detectNewline(contents)
-	const document = yaml.parseDocument(contents)
-
-	document.set('version', version)
-
-	return document.toString().replace(/\r?\n/g, newline)
-}

package/src/lib/write-file.js

@@ -1,6 +0,0 @@
-import fs from 'fs'
-
-export default function (args, filePath, content) {
-	if (args.dryRun) return
-	fs.writeFileSync(filePath, content, 'utf8')
-}

package/src/preset/constants.js

@@ -1,16 +0,0 @@
-export const DEFAULT_COMMIT_TYPES = Object.freeze(
-	[
-		{ type: 'feat', section: 'Features' },
-		{ type: 'feature', section: 'Features' },
-		{ type: 'fix', section: 'Bug Fixes' },
-		{ type: 'perf', section: 'Performance Improvements' },
-		{ type: 'revert', section: 'Reverts' },
-		{ type: 'docs', section: 'Documentation', hidden: true },
-		{ type: 'style', section: 'Styles', hidden: true },
-		{ type: 'chore', section: 'Miscellaneous Chores', hidden: true },
-		{ type: 'refactor', section: 'Code Refactoring', hidden: true },
-		{ type: 'test', section: 'Tests', hidden: true },
-		{ type: 'build', section: 'Build System', hidden: true },
-		{ type: 'ci', section: 'Continuous Integration', hidden: true },
-	].map(Object.freeze),
-)

package/src/preset/index.js

@@ -1,19 +0,0 @@
-import { DEFAULT_COMMIT_TYPES } from './constants.js'
-import { createParserOpts } from './parser.js'
-import { createWriterOpts } from './writer.js'
-import { createWhatBump } from './whatBump.js'
-
-export { DEFAULT_COMMIT_TYPES }
-export * from './templates/index.js'
-
-export default async function createPreset(config) {
-	return {
-		commits: {
-			ignore: config?.ignoreCommits,
-			merges: false,
-		},
-		parser: createParserOpts(config),
-		writer: await createWriterOpts(config),
-		whatBump: createWhatBump(config),
-	}
-}

package/src/preset/parser.js

@@ -1,11 +0,0 @@
-export function createParserOpts(config) {
-	return {
-		headerPattern: /^(\w*)(?:\((.*)\))?!?: (.*)$/,
-		breakingHeaderPattern: /^(\w*)(?:\((.*)\))?!: (.*)$/,
-		headerCorrespondence: ['type', 'scope', 'subject'],
-		noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
-		revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i,
-		revertCorrespondence: ['header', 'hash'],
-		issuePrefixes: config?.issuePrefixes || ['#'],
-	}
-}

package/src/preset/templates/commit.hbs

@@ -1,19 +0,0 @@
-* {{#if scope}}`{{scope}}` {{/if~}}
-{{#if subject}}{{subject}}{{else}}{{header}}{{/if}}
-
-{{~! commit link}}
-{{~#if hash}}
-	{{~#if @root.linkReferences}} ([{{shortHash}}]({{commitUrlFormat}}))
-	{{~else}} {{shortHash}}{{~/if}}
-{{~/if}}
-
-{{~! commit references}}
-{{~#if references}} (
-{{~#each references}}
-	{{#if @root.linkReferences~}}
-		[{{~#if owner}}{{owner}}/{{/if}}{{repository}}{{prefix}}{{issue}}]({{issueUrlFormat}})
-	{{~else}}
-		{{~#if owner}}{{owner}}/{{/if}}{{repository}}{{prefix}}{{issue}}
-{{~/if}}{{~#unless @last}}, {{/unless}}{{~#if @last}}){{~/if}}
-{{~/each}}
-{{~/if}}

package/src/preset/templates/footer.hbs

@@ -1,10 +0,0 @@
-{{#if fullChangelogLink~}}
-**Full Changelog:** {{#if previousTag~}}
-	[`{{previousTag}}...{{currentTag}}`]({{compareUrlFormat}})
-{{~else~}}
-	[`{{currentTag}}`]({{host}}/{{owner}}/{{repository}}/commits/{{currentTag}})
-{{~/if}}
-
-
-{{/if}}
-

package/src/preset/templates/header.hbs

@@ -1,10 +0,0 @@
-## {{#if previousTag~}}
-[{{currentTag}}]({{compareUrlFormat}})
-{{~else~}}
-[{{currentTag}}]({{host}}/{{owner}}/{{repository}}/commits/{{currentTag}})
-{{~/if}}
-{{~#if title}} "{{title}}"
-{{~/if}}
-{{~#if date}} ({{date}})
-{{/if}}
-

package/src/preset/templates/index.js

@@ -1,13 +0,0 @@
-import fs from 'fs'
-import path from 'path'
-
-const dirpath = import.meta.dirname
-
-function read(name) {
-	return fs.readFileSync(path.join(dirpath, `${name}.hbs`), 'utf-8')
-}
-
-export const main = read('main')
-export const header = read('header')
-export const commit = read('commit')
-export const footer = read('footer')

package/src/preset/templates/main.hbs

@@ -1,21 +0,0 @@
-{{> header}}
-{{#if noteGroups}}
-{{#each noteGroups}}
-### ⚠ {{title}}
-{{#each notes}}
-* {{#if commit.scope}}`{{commit.scope}}` {{/if}}{{text}}
-{{/each}}
-
-{{/each}}
-{{/if}}
-{{#each commitGroups}}
-{{#if title}}
-### {{title}}
-{{/if}}
-{{#each commits}}
-{{> commit}}
-
-{{/each}}
-
-{{/each}}
-{{> footer}}

package/src/preset/whatBump.js

@@ -1,33 +0,0 @@
-export function createWhatBump(config) {
-	return function whatBump(commits) {
-		let level = 2
-		let breakings = 0
-		let features = 0
-
-		commits.forEach((commit) => {
-			if (commit.notes.length > 0) {
-				breakings += commit.notes.length
-				level = 0
-			}
-			else if (commit.type === 'feat' || commit.type === 'feature') {
-				features += 1
-
-				if (level === 2) {
-					level = 1
-				}
-			}
-		})
-
-		if (config?.preMajor && level < 2) {
-			level++
-		}
-
-		return {
-			level,
-			reason:
-				breakings === 1
-					? `There is ${breakings} BREAKING CHANGE and ${features} features`
-					: `There are ${breakings} BREAKING CHANGES and ${features} features`,
-		}
-	}
-}

package/src/preset/writer.js

@@ -1,201 +0,0 @@
-import compareFunc from 'compare-func'
-import { DEFAULT_COMMIT_TYPES } from './constants.js'
-import { main, commit, header, footer } from './templates/index.js'
-
-const COMMIT_HASH_LENGTH = 7
-const releaseAsRegex = /release-as:\s*\w*@?([0-9]+\.[0-9]+\.[0-9a-z]+(-[0-9a-z.]+)?)\s*/i
-/**
- * Handlebar partials for various property substitutions based on commit context.
- */
-const owner = '{{#if this.owner}}{{~this.owner}}{{else}}{{~@root.owner}}{{/if}}'
-const host = '{{~@root.host}}'
-const repository = '{{#if this.repository}}{{~this.repository}}{{else}}{{~@root.repository}}{{/if}}'
-
-export async function createWriterOpts(config) {
-	const finalConfig = {
-		types: DEFAULT_COMMIT_TYPES,
-		issueUrlFormat: '{{host}}/{{owner}}/{{repository}}/issues/{{id}}',
-		commitUrlFormat: '{{host}}/{{owner}}/{{repository}}/commit/{{hash}}',
-		compareUrlFormat: '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
-		userUrlFormat: '{{host}}/{{user}}',
-		issuePrefixes: ['#'],
-		...config,
-	}
-	const commitUrlFormat = expandTemplate(finalConfig.commitUrlFormat, {
-		host,
-		owner,
-		repository,
-	})
-	const compareUrlFormat = expandTemplate(finalConfig.compareUrlFormat, {
-		host,
-		owner,
-		repository,
-	})
-	const issueUrlFormat = expandTemplate(finalConfig.issueUrlFormat, {
-		host,
-		owner,
-		repository,
-		id: '{{this.issue}}',
-		prefix: '{{this.prefix}}',
-	})
-	const writerOpts = getWriterOpts(finalConfig)
-
-	writerOpts.mainTemplate = main
-	writerOpts.headerPartial = header
-		.replace(/{{compareUrlFormat}}/g, compareUrlFormat)
-	writerOpts.commitPartial = commit
-		.replace(/{{commitUrlFormat}}/g, commitUrlFormat)
-		.replace(/{{issueUrlFormat}}/g, issueUrlFormat)
-	writerOpts.footerPartial = footer
-		.replace(/{{compareUrlFormat}}/g, compareUrlFormat)
-
-	return writerOpts
-}
-
-function getWriterOpts(config) {
-	const commitGroupOrder = config.types.flatMap(t => t.section).filter(t => t)
-
-	return {
-		finalizeContext: (context, _writerOpts, _filteredCommits, keyCommit) => {
-			if (keyCommit) {
-				const versionTagRegex = /tag:\s*([^,\s)]+)/i
-				const keyCommitTag = keyCommit.gitTags?.match(versionTagRegex)
-				if (keyCommitTag) {
-					context.currentTag = keyCommitTag[1]
-					const currentTagIndex = context.gitSemverTags.indexOf(context.currentTag)
-					context.previousTag = (currentTagIndex === -1) ? null : context.gitSemverTags[currentTagIndex + 1]
-				}
-			}
-			else {
-				context.currentTag = context.newTag || null
-				context.previousTag = context.gitSemverTags[0] || null
-			}
-			return context
-		},
-		transform: (commit, context) => {
-			let discard = true
-			const issues = []
-			const entry = findTypeEntry(config.types, commit)
-
-			// Add an entry in the CHANGELOG if special Release-As footer
-			// is used:
-			if ((commit.footer && releaseAsRegex.test(commit.footer))
-				|| (commit.body && releaseAsRegex.test(commit.body))) {
-				discard = false
-			}
-
-			const notes = commit.notes.map((note) => {
-				discard = false
-
-				return {
-					...note,
-					title: 'BREAKING CHANGES',
-				}
-			})
-
-			// breaking changes attached to any type are still displayed.
-			if (discard && (entry === undefined
-				|| entry.hidden)) {
-				return undefined
-			}
-
-			const type = entry
-				? entry.section
-				: commit.type
-			const scope = commit.scope === '*'
-				? ''
-				: commit.scope
-			const shortHash = typeof commit.hash === 'string'
-				? commit.hash.substring(0, COMMIT_HASH_LENGTH)
-				: commit.shortHash
-			let { subject } = commit
-
-			if (typeof subject === 'string') {
-				// Issue URLs.
-				const issueRegEx = `(${config.issuePrefixes.join('|')})([a-z0-9]+)`
-				const re = new RegExp(issueRegEx, 'g')
-
-				subject = subject.replace(re, (_, prefix, issue) => {
-					issues.push(prefix + issue)
-
-					const url = expandTemplate(config.issueUrlFormat, {
-						host: context.host,
-						owner: context.owner,
-						repository: context.repository,
-						id: issue,
-						prefix,
-					})
-
-					return `[${prefix}${issue}](${url})`
-				})
-				// User URLs.
-				subject = subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, user) => {
-					// TODO: investigate why this code exists.
-					if (user.includes('/')) {
-						return `@${user}`
-					}
-
-					const usernameUrl = expandTemplate(config.userUrlFormat, {
-						host: context.host,
-						owner: context.owner,
-						repository: context.repository,
-						user,
-					})
-
-					return `[@${user}](${usernameUrl})`
-				})
-			}
-
-			// remove references that already appear in the subject
-			const references = commit.references.filter(reference => !issues.includes(reference.prefix + reference.issue))
-
-			return {
-				notes,
-				type,
-				scope,
-				shortHash,
-				subject,
-				references,
-			}
-		},
-		groupBy: 'type',
-		// the groupings of commit messages, e.g., Features vs., Bug Fixes, are
-		// sorted based on their probable importance:
-		commitGroupsSort: (a, b) => {
-			const gRankA = commitGroupOrder.indexOf(a.title)
-			const gRankB = commitGroupOrder.indexOf(b.title)
-
-			return gRankA - gRankB
-		},
-		commitsSort: ['scope', 'subject'],
-		noteGroupsSort: 'title',
-		notesSort: compareFunc,
-	}
-}
-
-function findTypeEntry(types, commit) {
-	const typeKey = (commit.revert ? 'revert' : commit.type || '').toLowerCase()
-
-	return types.find((entry) => {
-		if (entry.type !== typeKey) {
-			return false
-		}
-
-		if (entry.scope && entry.scope !== commit.scope) {
-			return false
-		}
-
-		return true
-	})
-}
-
-// expand on the simple mustache-style templates supported in
-// configuration (we may eventually want to use handlebars for this).
-function expandTemplate(template, context) {
-	let expanded = template
-
-	Object.keys(context).forEach((key) => {
-		expanded = expanded.replace(new RegExp(`{{${key}}}`, 'g'), context[key])
-	})
-	return expanded
-}