Skip to content

Commit

Permalink
use CommonJS in update-readme script
Browse files Browse the repository at this point in the history
  • Loading branch information
dcastil committed Dec 16, 2021
1 parent 4442f5f commit 258fd73
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 23 deletions.
4 changes: 3 additions & 1 deletion scripts/helpers/apply-versioned-logo-image.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const LOGO_IMAGE_REGEX =
/(?<commentStart><!-- AUTOGENERATED START logo-image -->).+?(?<commentEnd><!-- AUTOGENERATED END -->)/

export function applyVersionedLogoImage(text, packageJson) {
function applyVersionedLogoImage(text, packageJson) {
const version = JSON.parse(packageJson).version
const hasPartsToUpdate = LOGO_IMAGE_REGEX.test(text) || !version
const versionedLogoImage = `<img src="https://github.com/dcastil/tailwind-merge/raw/v${version}/assets/logo.svg" alt="tailwind-merge" width="221px" />`
Expand All @@ -16,3 +16,5 @@ export function applyVersionedLogoImage(text, packageJson) {
updatedText,
}
}

module.exports = { applyVersionedLogoImage }
48 changes: 26 additions & 22 deletions scripts/update-readme.js
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
// File can only be executed with zx
import 'zx/globals'
import { pipe } from 'fp-ts/lib/function.js'
require('zx/globals')
const { pipe } = require('fp-ts/lib/function')

import { applyVersionedLogoImage } from './helpers/apply-versioned-logo-image.js'
const { applyVersionedLogoImage } = require('./helpers/apply-versioned-logo-image')

const ROOT_PATH = `${__dirname}/..`
const README_PATH = `${ROOT_PATH}/README.md`
const PACKAGE_PATH = `${ROOT_PATH}/package.json`
async function run() {
const ROOT_PATH = `${__dirname}/..`
const README_PATH = `${ROOT_PATH}/README.md`
const PACKAGE_PATH = `${ROOT_PATH}/package.json`

const [readme, packageJson] = await Promise.all([
fs.readFile(README_PATH, { encoding: 'utf-8' }),
fs.readFile(PACKAGE_PATH, { encoding: 'utf-8' }),
])
const [readme, packageJson] = await Promise.all([
fs.readFile(README_PATH, { encoding: 'utf-8' }),
fs.readFile(PACKAGE_PATH, { encoding: 'utf-8' }),
])

const nextReadme = pipe(readme, (readme) => {
const { hasPartsToUpdate, updatedText } = applyVersionedLogoImage(readme, packageJson)
const nextReadme = pipe(readme, (readme) => {
const { hasPartsToUpdate, updatedText } = applyVersionedLogoImage(readme, packageJson)

if (!hasPartsToUpdate) {
throw Error(
`${chalk.red('[ERROR]')} Could not find versioned logo image to update in README`
)
}
if (!hasPartsToUpdate) {
throw Error(
`${chalk.red('[ERROR]')} Could not find versioned logo image to update in README`
)
}

return updatedText
})

return updatedText
})
if (nextReadme !== readme) {
await fs.writeFile(README_PATH, nextReadme)
}

if (nextReadme !== readme) {
await fs.writeFile(README_PATH, nextReadme)
await $`git add README.md`
}

await $`git add README.md`
run()

0 comments on commit 258fd73

Please sign in to comment.