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

**refactor: consolidate folder structure and improve compatibility**

Browse source 
### Changes:
- **rollup.config.js**:
  - Merged and reformatted `nodeBuiltins` definition for cleaner code.
  - Updated `input` path from `examples/browser_compatible_exports.ts` to `demo/browser_compatible_exports.ts`.
  - Reformatted `replace` plugin configuration for better readability.

- **.github/workflows/deploy-demo.yml**:
  - Updated deployment folder from `examples` to `demo`.

- **Renamed**:
  - `examples/browser_compatible_exports.ts` → `demo/browser_compatible_exports.ts`.

- **scripts/generate-version.js**:
  - Removed unnecessary semicolons for consistent formatting.

### Purpose:
Aligned folder structure by migrating from `examples` to `demo` for uniformity and better organization. Improved code readability and formatting across configurations and scripts.
This commit is contained in:
David Snelling 2025-06-23 10:58:48 -07:00
parent 151aeb1e87
commit 37c4da58f7
4 changed files with 34 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

46
scripts/generate-version.js
View file

@ -2,44 +2,44 @@
/**
* Generate Version Script
*
*
* This script generates a version.js file that exports the version from package.json.
* This allows the CLI to access the version without having to read package.json directly,
* which can be problematic when the package is installed globally.
*
*
* It also updates the version in the README.md file to ensure it stays in sync with package.json.
*/
import fs from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';
import fs from 'fs'
import path from 'path'
import { fileURLToPath } from 'url'
// Get the directory of the current module
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
// Path to the root directory
const rootDir = path.join(__dirname, '..');
const rootDir = path.join(__dirname, '..')
// Path to package.json
const packageJsonPath = path.join(rootDir, 'package.json');
const packageJsonPath = path.join(rootDir, 'package.json')
// Path to the output directory
const outputDir = path.join(rootDir, 'src', 'utils');
const outputDir = path.join(rootDir, 'src', 'utils')
// Path to the output file
const outputFile = path.join(outputDir, 'version.ts');
const outputFile = path.join(outputDir, 'version.ts')
// Path to README.md
const readmePath = path.join(rootDir, 'README.md');
const readmePath = path.join(rootDir, 'README.md')
// Read package.json
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
const version = packageJson.version;
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
const version = packageJson.version
// Create the output directory if it doesn't exist
if (!fs.existsSync(outputDir)) {
fs.mkdirSync(outputDir, { recursive: true });
fs.mkdirSync(outputDir, { recursive: true })
}
// Generate the version.ts file
@ -49,26 +49,26 @@ const content = `/**
*/
export const VERSION = '${version}';
`;
`
// Write the file
fs.writeFileSync(outputFile, content);
fs.writeFileSync(outputFile, content)
console.log(`Generated version.ts with version ${version}`);
console.log(`Generated version.ts with version ${version}`)
// Update README.md with the current version
try {
let readmeContent = fs.readFileSync(readmePath, 'utf8');
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)]`
);
)
// Write the updated README back to disk
fs.writeFileSync(readmePath, updatedReadme);
console.log(`Updated README.md with version ${version}`);
fs.writeFileSync(readmePath, updatedReadme)
console.log(`Updated README.md with version ${version}`)
} catch (error) {
console.error('Error updating README.md:', error);
console.error('Error updating README.md:', error)
}