diff --git a/.changeset/wild-bulldogs-dance.md b/.changeset/wild-bulldogs-dance.md new file mode 100644 index 0000000..bdb0462 --- /dev/null +++ b/.changeset/wild-bulldogs-dance.md @@ -0,0 +1,8 @@ +--- +"create-astro-reactive": patch +"@astro-reactive/validator": patch +"@astro-reactive/form": patch +"@astro-reactive/docs": patch +--- + +- Update documentation links to release notes diff --git a/README.md b/README.md index 66a5bd8..d78aa75 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
Server-Side Rendered, Dynamic Components
- Let your data build your UI with native Astro components. + Let your data build your UI with Astro

@@ -27,8 +27,8 @@ | Package | Release notes | Description | | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [form](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](./packages/form/RELEASE.md) | a dynamic form which can be modified programmatically | -| [validator](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](./packages/validator/RELEASE.md) | validators for editable fields | +| [form](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](./packages/form/CHANGELOG.md) | a dynamic form which can be modified programmatically | +| [validator](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](./packages/validator/CHANGELOG.md) | validators for editable fields | | data-grid | 🛠 | a dynamic data grid of values | | themes | 🛠 | easy-to-use, accessible, consistent cross-browser styles | | viz | 🛠 | data visualization that emits and responds to events | diff --git a/apps/demo/CHANGELOG.md b/apps/demo/CHANGELOG.md index 715c73c..991694d 100644 --- a/apps/demo/CHANGELOG.md +++ b/apps/demo/CHANGELOG.md @@ -7,8 +7,8 @@ - fb11b73: Initial `create-astro-reactive` package Update packages' meta information (author, homepage) Upadte LICENSE owner info to `astro-reactive` organization -- 30de516: 1. Change the default of `validateOnLoad` property to true, making server-side rendering validation the default behavior for the `Form` component. - 1. Update the demo `index.astro` page by removing the `validateOnLoad` property/directive on the example which should still result to server-side rendered validation results. +- 30de516: Change the default of `validateOnLoad` property to true, making server-side rendering validation the default behavior for the `Form` component. + Update the demo `index.astro` page by removing the `validateOnLoad` property/directive on the example which should still result to server-side rendered validation results. - Updated dependencies [fb11b73] - Updated dependencies [30de516] - @astro-reactive/validator@0.3.3 diff --git a/apps/docs/src/pages/en/introduction.md b/apps/docs/src/pages/en/introduction.md index c9530e1..9032bfb 100644 --- a/apps/docs/src/pages/en/introduction.md +++ b/apps/docs/src/pages/en/introduction.md @@ -50,8 +50,8 @@ We will also make this clear in our library documentation as we see them. | Package | Release notes | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [form](/en/api/form/form-component) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/RELEASE.md) | a dynamic form which can be modified programmatically | -| [validator](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/RELEASE.md) | validators for editable fields | +| [form](/en/api/form/form-component) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/CHANGELOG.md) | a dynamic form which can be modified programmatically | +| [validator](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/CHANGELOG.md) | validators for editable fields | | data-grid | 🛠 | a dynamic data grid of values | | themes | 🛠 | easy-to-use, accessible, consistent cross-browser styles | | viz | 🛠 | data visualization that emits and responds to events | diff --git a/packages/create-astro-reactive/README.md b/packages/create-astro-reactive/README.md index fe37efa..a74a04e 100644 --- a/packages/create-astro-reactive/README.md +++ b/packages/create-astro-reactive/README.md @@ -33,5 +33,4 @@ npm create astro-reactive@latest _All [contributions](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md) are welcome. Let's make the fastest web forms powered by Astro._ -👉 _This package is a work in progress. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/create-astro-reactive/RELEASE.md)._ - +👉 _This package is a work in progress. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/create-astro-reactive/CHANGELOG.md)._ \ No newline at end of file diff --git a/packages/form/CHANGELOG.md b/packages/form/CHANGELOG.md index 07b028d..643130f 100644 --- a/packages/form/CHANGELOG.md +++ b/packages/form/CHANGELOG.md @@ -4,8 +4,8 @@ ### Minor Changes -- 30de516: 1. Change the default of `validateOnLoad` property to true, making server-side rendering validation the default behavior for the `Form` component. - 1. Update the demo `index.astro` page by removing the `validateOnLoad` property/directive on the example which should still result to server-side rendered validation results. +- 30de516: Change the default of `validateOnLoad` property to true, making server-side rendering validation the default behavior for the `Form` component. + Update the demo `index.astro` page by removing the `validateOnLoad` property/directive on the example which should still result to server-side rendered validation results. ### Patch Changes diff --git a/packages/form/README.md b/packages/form/README.md index 326a235..de76eea 100644 --- a/packages/form/README.md +++ b/packages/form/README.md @@ -105,5 +105,5 @@ This Form component is designed to work with [Astro Reactive Validator](https:// 👉 _All [contributions](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md) are welcome. Let's make the fastest web forms powered by Astro._ -👉 _This package is a work in progress. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/RELEASE.md)._ +👉 _This package is a work in progress. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/CHANGELOG.md)._ diff --git a/packages/pr-updater.js b/packages/pr-updater.js index 4074489..28e3dbe 100644 --- a/packages/pr-updater.js +++ b/packages/pr-updater.js @@ -1,107 +1,114 @@ -import fs from 'fs'; -import { fileURLToPath } from 'url'; -import * as path from 'path'; -import promptSync from 'prompt-sync'; +import fs from "fs"; +import { fileURLToPath } from "url"; +import * as path from "path"; +import promptSync from "prompt-sync"; -const prompt = promptSync({sigint: true}); +const prompt = promptSync({ sigint: true }); const __filename = fileURLToPath(import.meta.url); const __dirname = path.dirname(__filename); function writeReleaseMD(releaseFile, featuresArr, fixesArr) { - var formattedMessage = ""; + var formattedMessage = ""; - if (featuresArr.length != 0) { - formattedMessage += "Features"; - for (var line of featuresArr) { - formattedMessage += "\n\t- " + line; - } - formattedMessage += "\n\n"; + if (featuresArr.length != 0) { + formattedMessage += "Features"; + for (var line of featuresArr) { + formattedMessage += "\n\t- " + line; } + formattedMessage += "\n\n"; + } - if (fixesArr.length != 0) - { - formattedMessage += "Fixes"; - for (var line of fixesArr) { - formattedMessage += "\n\t- " + line; - } - formattedMessage += "\n\n"; + if (fixesArr.length != 0) { + formattedMessage += "Fixes"; + for (var line of fixesArr) { + formattedMessage += "\n\t- " + line; } + formattedMessage += "\n\n"; + } - //write file - var oldRelease = fs.readFileSync(releaseFile); - var fd = fs.openSync(releaseFile, 'w+'); + //write file + var oldRelease = fs.readFileSync(releaseFile); + var fd = fs.openSync(releaseFile, "w+"); - fs.writeSync(fd, formattedMessage, 0, formattedMessage.length, 0); - fs.writeSync(fd, oldRelease, 0, oldRelease.length, formattedMessage.length); - fs.close(fd); + fs.writeSync(fd, formattedMessage, 0, formattedMessage.length, 0); + fs.writeSync(fd, oldRelease, 0, oldRelease.length, formattedMessage.length); + fs.close(fd); } function main() { - console.log("Astro Reactive PR Release Updater (ctrl-c to exit)"); + console.log("Astro Reactive PR Release Updater (ctrl-c to exit)"); - var noChanged, feature, fix, breakExisting; - var featuresArr = []; - var fixesArr = []; + var noChanged, feature, fix, breakExisting; + var featuresArr = []; + var fixesArr = []; - do { - console.log(`What package is changed? + do { + console.log(`What package is changed? 1. Common 2. Form 3. Validator`); - noChanged = prompt(": "); - } while (isNaN(noChanged) || parseInt(noChanged) < 1 || parseInt(noChanged) > 3); + noChanged = prompt(": "); + } while ( + isNaN(noChanged) || + parseInt(noChanged) < 1 || + parseInt(noChanged) > 3 + ); - do { - console.log("Description of feature (q to finish): "); - feature = prompt(": "); - - if (feature != "q") { - console.log("Will this code change break existing examples and/or demo applications? Y/N"); - breakExisting = prompt(": "); - if (breakExisting == "Y" || breakExisting == "y") { - feature += " (BREAKING CHANGE)"; - } - featuresArr.push(feature); - } - } while (feature != "q"); + do { + console.log("Description of feature (q to finish): "); + feature = prompt(": "); - do { - console.log("Description of fix (q to finish): "); - fix = prompt(": "); - - if (fix != "q") { - console.log("Will this code change break existing examples and/or demo applications? Y/N"); - breakExisting = prompt(": "); - if (breakExisting == "Y" || breakExisting == "y") { - fix += " (BREAKING CHANGE)"; - } - fixesArr.push(fix); - } - } while (fix != "q"); - - switch (noChanged) { - case '1': - var releaseFile = path.resolve(__dirname, './common/RELEASE.md'); - writeReleaseMD(releaseFile, featuresArr, fixesArr); - break; - case '2': - var releaseFile = path.resolve(__dirname, './form/RELEASE.md'); - writeReleaseMD(releaseFile, featuresArr, fixesArr); - break; - case '3': - var releaseFile = path.resolve(__dirname, './validator/RELEASE.md'); - writeReleaseMD(releaseFile, featuresArr, fixesArr); - break; - default: - console.log("Invalid package specified."); + if (feature != "q") { + console.log( + "Will this code change break existing examples and/or demo applications? Y/N" + ); + breakExisting = prompt(": "); + if (breakExisting == "Y" || breakExisting == "y") { + feature += " (BREAKING CHANGE)"; + } + featuresArr.push(feature); } + } while (feature != "q"); + + do { + console.log("Description of fix (q to finish): "); + fix = prompt(": "); + + if (fix != "q") { + console.log( + "Will this code change break existing examples and/or demo applications? Y/N" + ); + breakExisting = prompt(": "); + if (breakExisting == "Y" || breakExisting == "y") { + fix += " (BREAKING CHANGE)"; + } + fixesArr.push(fix); + } + } while (fix != "q"); + + switch (noChanged) { + case "1": + var releaseFile = path.resolve(__dirname, "./common/CHANGELOG.md"); + writeReleaseMD(releaseFile, featuresArr, fixesArr); + break; + case "2": + var releaseFile = path.resolve(__dirname, "./form/CHANGELOG.md"); + writeReleaseMD(releaseFile, featuresArr, fixesArr); + break; + case "3": + var releaseFile = path.resolve(__dirname, "./validator/CHANGELOG.md"); + writeReleaseMD(releaseFile, featuresArr, fixesArr); + break; + default: + console.log("Invalid package specified."); + } } var continueScript; do { - main(); - console.log("Do you want to update another package release? (Y to continue)"); - continueScript = prompt(": "); -} while (continueScript == 'Y' || continueScript == 'y'); \ No newline at end of file + main(); + console.log("Do you want to update another package release? (Y to continue)"); + continueScript = prompt(": "); +} while (continueScript == "Y" || continueScript == "y"); diff --git a/packages/validator/README.md b/packages/validator/README.md index 7bf97d0..4491552 100644 --- a/packages/validator/README.md +++ b/packages/validator/README.md @@ -103,5 +103,5 @@ This validation library is designed to work with [Astro Reactive Form](https://w 👉 _All [contributions](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md) are welcome. Let's make the validation library for Astro._ -👉 _This package is a work in progress. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/RELEASE.md)_. +👉 _This package is a work in progress. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/CHANGELOG.md)_.