Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README.md): edit example of configuration file #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

manudeli
Copy link
Member

@manudeli manudeli commented Feb 8, 2023

Edit README.md to remove chance of making mistake by beginners

I don't use Plug'n'play nodeLinker. so My monorepo:https://github.com/suspensive/react was having packages/*/node_modules.

AS-IS: current guide to config packlint

// packlint.config.mjs
```js
// packlint.config.mjs
export default {
  files: ['./packages/**/package.json'],
  ignores: ['./package.json'],
  rules: {
    merge: {  
      type: 'module',
      scripts: {
        prepack: 'yarn build',
        build: 'rm -rf dist && tsup ./src/index.ts --format esm --dts',
        dev: 'yarn run build --watch',
        typecheck: 'tsc --noEmit',
      },
      publishConfig: {
        access: 'public',
      },
    },
  },
};

but when I use packlint.config.mjs following as README.md's configuration guide, I met error like below picture.

image

actually It's not really problem. because I fixed it after edit configuration file like this Pull Request's file changed.
but many package don't use Plug'n'Play yet, so I don't want to let leave obstacle for packlint beginner anymore.
It's why I make this Pull Request.

Other context

Actually I think this Pull Request is not perfect solution. so I want to suggest other way to solve this problem:making packlint can ignore packages//node_modules defaultly, not configuration. I guess that packages//node_modules is not goal of packlint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant