apply-ntt-shopify-framework

A CLI tool to create a component folder inside app/routes and an assets folder inside that component folder. It also generates a .eslintrc.cjs file with recommended ESLint and Prettier settings for Remix projects.

Version: 2.1.0

Installation

You can install globally (recommended for CLI usage):

npm install -g apply-ntt-shopify-framework
apply-ntt-shopify-framework

Or use with npx (no install required):

npx apply-ntt-shopify-framework

Or run directly from the project folder:

node index.js

Usage

Navigate to the root of your project (where the app folder is located), then run:

apply-ntt-shopify-framework

This will:

1. Create the following structure if it does not already exist:

app/
  routes/
    component/
      assets/

2. Create a .eslintrc.cjs file in your project root with the following configuration:

module.exports = {
  root: true,
  extends: [
    "@remix-run/eslint-config",
    "@remix-run/eslint-config/node",
    "@remix-run/eslint-config/jest-testing-library",
    "prettier",
  ],
  globals: {
    shopify: "readonly"
  },
  rules: {
    'camelcase': ['error', { properties: 'always' }],
    'no-console': 'warn',
    'id-length': ['warn', { min: 3, max: 30, exceptions: ['fs', 'os', 'id', 'db'] }],
  },
};

License

ISC