@nx/js

What is @nx/js?

@nx/js is a package that provides tools and utilities for managing JavaScript projects within the Nx workspace. It offers functionalities for building, testing, and managing dependencies in JavaScript projects.

What are @nx/js's main functionalities?

Building JavaScript Projects

This feature allows you to build JavaScript projects using the Nx build executor. The code sample demonstrates how to configure a project named 'myApp' with build options.

module.exports = {
  projects: {
    myApp: {
      root: 'apps/my-app',
      sourceRoot: 'apps/my-app/src',
      projectType: 'application',
      targets: {
        build: {
          executor: '@nx/js:build',
          options: {
            outputPath: 'dist/apps/my-app',
            main: 'apps/my-app/src/main.ts',
            tsConfig: 'apps/my-app/tsconfig.app.json'
          }
        }
      }
    }
  }
};

Testing JavaScript Projects

This feature allows you to test JavaScript projects using the Nx test executor. The code sample demonstrates how to configure a project named 'myApp' with test options.

module.exports = {
  projects: {
    myApp: {
      root: 'apps/my-app',
      sourceRoot: 'apps/my-app/src',
      projectType: 'application',
      targets: {
        test: {
          executor: '@nx/js:test',
          options: {
            jestConfig: 'apps/my-app/jest.config.js',
            passWithNoTests: true
          }
        }
      }
    }
  }
};

Managing Dependencies

This feature allows you to manage dependencies and lint JavaScript projects using the Nx lint executor. The code sample demonstrates how to configure a project named 'myApp' with lint options.

module.exports = {
  projects: {
    myApp: {
      root: 'apps/my-app',
      sourceRoot: 'apps/my-app/src',
      projectType: 'application',
      targets: {
        lint: {
          executor: '@nx/js:lint',
          options: {
            lintFilePatterns: ['apps/my-app/**/*.ts']
          }
        }
      }
    }
  }
};

Other packages similar to @nx/js

webpack

Webpack is a popular module bundler for JavaScript applications. It allows you to bundle JavaScript files for usage in a browser and offers a wide range of plugins and loaders. Compared to @nx/js, Webpack is more focused on the bundling aspect and does not provide the same level of project management and dependency management features.

jest

Jest is a delightful JavaScript testing framework with a focus on simplicity. It works with projects using Babel, TypeScript, Node.js, React, Angular, Vue.js, and Svelte. Compared to @nx/js, Jest is specifically focused on testing and does not provide build or dependency management features.

eslint

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It helps in maintaining code quality and consistency. Compared to @nx/js, ESLint is specifically focused on linting and does not provide build or testing features.

README

Nx: Smart Monorepos · Fast CI

Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.

This package is a JavaScript/TypeScript plugin for Nx.

Getting Started

Creating an Nx Workspace

Using npx

npx create-nx-workspace

Using npm init

npm init nx-workspace

Using yarn create

yarn create nx-workspace

Adding Nx to an Existing Repository

Run:

npx nx@latest init

Documentation & Resources

• Nx.Dev: Documentation, Guides, Tutorials
• Intro to Nx
• Official Nx YouTube Channel
• Blog Posts About Nx