Savva Prokofev - Portfolio
Explorer
Open Editors
Portfolio
.nuxt
node_modules
public
README.md
src
apps
ShortqixWebBidNews TemplateThesis
extensions
HomeDash
packages
nuxtignore-dev
.gitignore
nuxt.config.ts
package.json
pnpm-lock.yaml
tsconfig.json
Outline
Timeline
Scripts
nuxtignore-dev

nuxtignore-dev

Tool for ignoring specific files in development mode for Nuxt projects

Industry
Development tools
Year
2024
Service
Nuxt module

Overview

Nuxtignore Dev is a Nuxt module built with TypeScript that extends the functionality of .nuxtignore for development purposes only. The module uses a .nuxtignore.dev file, analogous to .env.dev, to selectively ignore pages and routes during development builds, helping developers work with large projects more efficiently.

The module is developed using TypeScript (81.8% of codebase) with Vue components (13.9%) and JavaScript (4.3%). It supports both Nuxt 2 and Nuxt 3 versions, providing backward compatibility and future-proofing for different project setups. The codebase follows modern development practices with automated releases and comprehensive testing.

The primary use case is optimizing development builds for large Nuxt applications with numerous pages. By allowing developers to specify which pages to ignore during development, the module significantly reduces build times and improves developer experience when working on specific features or sections of the application.

  • TypeScript-based Nuxt module development
  • Support for both Nuxt 2 and Nuxt 3
  • Development-only page ignoring functionality
  • Custom file path configuration
  • Strict mode for error handling
  • Pages extend hook integration
  • Environment-based enabling/disabling
  • NPM package distribution
  • Automated release management

The module provides flexible configuration options including custom file paths, strict mode for error handling, and integration with Nuxt's pages:extend hook. It can be conditionally enabled based on environment variables and supports custom ignore file locations for different deployment scenarios.

The project uses pnpm workspaces for monorepo management with separate packages for core functionality and playground testing. Development workflow includes automated releases through GitHub Actions with release-please for version management, ensuring consistent and reliable package updates for the Nuxt ecosystem.

Technologies

  • TypeScript
  • Nuxt 2/3
  • ESLint
  • Prettier
  • Playwright
  • Vitest
  • Pnpm Workspace
  • GitHub Actions
Live Preview
npmjs.com/package/nuxtignore-dev
Source code
github.com/websavva/nuxtignore-dev