This repository provides a collection of base configurations and CLI wrappers designed to streamline development for Node.js and browser projects, particularly within the Spotify ecosystem. It aims to offer an opinionated yet configurable solution for building, linting, testing, formatting, and releasing code, inspired by popular tools like react-scripts.

How It Works

The @spotify/web-scripts CLI acts as a unified entry point for common development tasks. It bundles configurations for ESLint, Prettier, TypeScript, and Jest, promoting a consistent development workflow. The methodology emphasizes pushing "fast" checks left, leveraging code editors for immediate feedback, Git hooks for pre-commit validation, and CI for final checks. This approach aims to minimize runtime errors and simplify the adoption of new linting or formatting rules across projects.

Quick Start & Requirements

• Install via npm: yarn add --dev @spotify/web-scripts husky
• Requires Node.js and yarn.
• Setup involves adding scripts to package.json and configuring Husky hooks.
• Full CLI documentation: [link to CLI documentation]
• Library scaffolding: yarn create @spotify/web-scripts-library my-library-name

Highlighted Details

• Combines ESLint, Prettier, TypeScript, and Jest configurations.
• Opinionated but configurable to avoid lock-in.
• Integrates with Husky for Git hooks (pre-commit, commit-msg).
• Supports automatic release management via semantic-release and lerna.

Maintenance & Community

• DEPRECATED: No longer actively maintained or receiving updates as of 2023-12-15.
• Primarily developed by Spotify engineers.
• Open Code of Conduct: [link to Open Code of Conduct]

Licensing & Compatibility

• License: Not explicitly stated in the README, but Spotify typically uses permissive licenses for open-source projects. Compatibility for commercial use or closed-source linking is likely, but requires verification.

Limitations & Caveats

This repository is officially deprecated and will not receive further updates or bug fixes. Users should consider this a legacy tool and explore actively maintained alternatives. The README mentions a workaround for a Husky bug using sed, indicating potential fragility in hook setup.