Как запустить пакет npm локально?

Question

Я пытаюсь внести свой вклад в пакет реактивных компонентов с открытым исходным кодом npm. Я знаю, как решить проблему, но я не знаю, как запустить проект локально на моей машине, чтобы протестировать его. Я клонировал репозиторий GitHub и не уверен, как запустить его локально. Это моя первая попытка с открытым исходным кодом. Не могли бы вы помочь мне?

Answer 1

npm link - это функция, предоставляемая npm из коробки, которая позволяет вам делать это.

Вы можете прочитать эту среднюю статью , где автор объясняет это приятно.

Answer 2

Обычно (в хорошо поддерживаемых репозиториях) вы найдете руководство для вкладчиков под .github/CONTRIBUTING.md.

Но этого достаточно, чтобы разобраться в разделе scripts в package.json, чтобы понять действия, доступные в текущем рабочем пространстве, там вы обычно заметите такие действия, как: start, develop и test.

  "scripts": {
    "build": "microbundle-crl --no-compress --format modern,cjs",
    "start": "microbundle-crl watch --no-compress --format modern,cjs",
    "prepublish": "run-s build",
    "test": "run-s test:unit test:lint test:build",
    "test:build": "run-s build",
    "test:lint": "eslint .",
    "test:unit": "cross-env CI=1 react-scripts test --env=jsdom",
    "test:watch": "react-scripts test --env=jsdom",
    "predeploy": "cd example && yarn install && yarn run build",
    "deploy": "gh-pages -d example/build"
  }

# will start the development env
npm start 

См. Первый взнос РЕПО.

Это сложно. Всегда тяжело в первый раз, когда ты что-то делаешь. Особенно когда вы сотрудничаете, совершать ошибки не очень удобно. Мы хотели упростить способ, которым новые участники с открытым исходным кодом учатся и вносят свой вклад впервые.