Rollup Scripts

Common errors

• command not found: rollup-scripts

  cause The 'rollup-scripts' executable is not in the system's PATH or not accessible in the current project context.
  fix Ensure 'rollup-scripts' is installed as a dev dependency ('npm i -D rollup-scripts') and run it via 'npx rollup-scripts <command>' or through an npm script defined in package.json (e.g., 'npm run build').

• Error: No entry file found for compilation.

  cause Rollup Scripts could not locate a default entry file (e.g., 'src/index.mjs', 'src/index.js', 'src/index.ts') or the `package.json` 'main'/'module' fields are misconfigured for the intended output.
  fix Verify that a supported entry file exists in your 'src' directory (e.g., 'src/index.mjs') and that your `package.json` 'main' and 'module' fields correctly point to the intended output paths and file types.

Warnings

• breaking This package is explicitly experimental and in active development. Version 0.0.x is unstable and should only be used for trial purposes. Breaking changes are frequent and without prior notice.
  Fix: Avoid using in production environments. Monitor the GitHub repository for stable releases (e.g., 1.0.0) and breaking change announcements.
• gotcha Do not install this package globally. It is designed to be installed as a local development dependency to ensure project-specific versioning and avoid conflicts.
  Fix: Install using 'npm i -D --save-exact rollup-scripts' within your project directory.
• gotcha Rollup Scripts enforces a 'zero config' approach, which means it expects specific file structures and `package.json` configurations (e.g., 'src/index.mjs' as an entry, 'main'/'module' fields) to function correctly.
  Fix: Carefully follow the 'Getting started' guide in the README, ensuring your project structure and package.json scripts and entry points align with the recommended setup.

Install

• npm install rollup-scripts npm
• yarn add rollup-scripts yarn
• pnpm add rollup-scripts pnpm

Imports

• rollup-scripts executable
  wrong:

  import rollupScripts from 'rollup-scripts'

  correct:

  npx rollup-scripts <command>

  This package is a command-line interface (CLI) tool and is not intended for direct import into JavaScript or TypeScript code. It should be executed via 'npx' or npm scripts.
• build script
  wrong:

  "build": "node_modules/.bin/rollup-scripts build"

  correct:

  "build": "rollup-scripts build"

  The recommended way to use rollup-scripts commands is through npm scripts in your package.json, which automatically handles path resolution and ensures the local installation is used.

Quickstart

Initializes an npm project, installs rollup-scripts, creates a basic ESM entry file, provides instructions to configure package.json scripts, and executes a build.

# 1. Create an npm project
npm init -y

# 2. Install rollup-scripts as a dev dependency
npm i -D --save-exact rollup-scripts

# 3. Create a source directory and an entry file
mkdir src
echo "export const greet = (name) => \`Hello, \${name} from Rollup Scripts!\`;\nexport const PI = 3.14159;" > src/index.mjs

# 4. Manually update your package.json file.
#    Ensure it looks similar to this, especially the 'main', 'module', and 'scripts' sections:
#    {
#      "name": "my-library-with-rollup-scripts",
#      "version": "1.0.0",
#      "main": "dist/umd/index.js",
#      "module": "dist/esm/index.mjs",
#      "scripts": {
#        "build": "rollup-scripts build",
#        "lint": "rollup-scripts lint",
#        "init": "rollup-scripts init"
#      },
#      "devDependencies": {
#        "rollup-scripts": "^0.0.131" // Adjust version as necessary
#      }
#    }

# 5. Run the build command
npm run build

# After successful build, verify the output (e.g., check 'dist' folder).
# Example of using the built UMD module:
# node -e "const { greet } = require('./dist/umd/index.js'); console.log(greet('AI Agent'));"