soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

feat(scripts): enhance version script and update badges dynamically in README

Browse source 
- Added a new `version` script in `package.json` to execute `generate-version.js` for automated version management.
- Enhanced `generate-version.js` to dynamically update badges in `README.md` for npm version, Node.js version, and TypeScript version.
- Modified badge update logic to retrieve Node.js and TypeScript versions from `package.json` for accuracy.
- Updated `VERSION` constant in `version.ts` to `0.9.7` to reflect the latest release.
- Streamlined the versioning process for better maintainability and consistency in documentation.
This commit is contained in:
David Snelling 2025-06-24 10:57:27 -07:00
parent 5e773e0110
commit 1c68d51be1
3 changed files with 27 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

32
scripts/generate-version.js
View file

@ -56,19 +56,37 @@ fs.writeFileSync(outputFile, content)
console.log(`Generated version.ts with version ${version}`)
// Update README.md with the current version
// Update README.md with the current version, Node.js version, and TypeScript version
try {
let readmeContent = fs.readFileSync(readmePath, 'utf8')
// Replace the version in the badge URL
const updatedReadme = readmeContent.replace(
/\[\!\[Version\]\(https:\/\/img\.shields\.io\/badge\/version-[0-9]+\.[0-9]+\.[0-9]+-blue\.svg\)\]/g,
`[![Version](https://img.shields.io/badge/version-${version}-blue.svg)]`
// Get Node.js version requirement from package.json
const nodeVersion = packageJson.engines.node.replace('>=', '')
// Get TypeScript version from package.json devDependencies
const typescriptVersion = packageJson.devDependencies.typescript.replace('^', '')
// Update npm badge
readmeContent = readmeContent.replace(
/\[\!\[npm\]\(https:\/\/img\.shields\.io\/npm\/v\/@soulcraft\/brainy\.svg\)\]\(https:\/\/www\.npmjs\.com\/package\/@soulcraft\/brainy\)/g,
`[![npm](https://img.shields.io/npm/v/@soulcraft/brainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy)`
)
// Update Node.js badge
readmeContent = readmeContent.replace(
/\[\!\[Node\.js\]\(https:\/\/img\.shields\.io\/badge\/node-%3E%3D[0-9]+\.[0-9]+\.[0-9]+-brightgreen\.svg\)\]\(https:\/\/nodejs\.org\/\)/g,
`[![Node.js](https://img.shields.io/badge/node-%3E%3D${nodeVersion}-brightgreen.svg)](https://nodejs.org/)`
)
// Update TypeScript badge
readmeContent = readmeContent.replace(
/\[\!\[TypeScript\]\(https:\/\/img\.shields\.io\/badge\/TypeScript-[0-9]+\.[0-9]+\.[0-9]+-blue\.svg\)\]\(https:\/\/www\.typescriptlang\.org\/\)/g,
`[![TypeScript](https://img.shields.io/badge/TypeScript-${typescriptVersion}-blue.svg)](https://www.typescriptlang.org/)`
)
// Write the updated README back to disk
fs.writeFileSync(readmePath, updatedReadme)
console.log(`Updated README.md with version ${version}`)
fs.writeFileSync(readmePath, readmeContent)
console.log(`Updated README.md with npm version ${version}, Node.js version ${nodeVersion}, and TypeScript version ${typescriptVersion}`)
} catch (error) {
console.error('Error updating README.md:', error)
}