ONE DUDE`S BLOG

/media/npm.webp

Как опубликовать свой npm пакет?

08.05.2022
Step by step гайд о том, как опубликовать свой npm пакет.

Так получилось, что за все время работы с js/ts, я ниразу не публиковал свои пакеты. На это было несколько причин (ага, бональная лень). Однако, с недавних пор, у меня появилось чуть больше свободного времени. Поэтому я решил активно заняться одним open source проектом, и в нем, как раз, потребовалось опубликовать подобный пакет. Процедура максимально тривиальная, тем не менее, для первого раза данный тутор может быть полезен.

Ссылки

Перед публикаций

Необходимо:

Процедура установки

  1. Иницилизировать в cli информацию о npm

    npm set init.author.name "<your-name>"
    npm set init.author.email "<your-email-address">
    npm set init.author.url "<your-website-url>"
    
  2. Залогиниться в npm

    npm login

  3. Шаг по установки пакета опустим, обычный npm init.

    На текущем этапе у вас должен уже быть свой пакет.

  4. Typescript

    Для typescript необходимо добавить дополнительную информацию в tsconfig.json

        "declaration": true,
    

    и в package.json

      "types": "dist/index.d.ts",
    

    Так же, необходимо добавить prebulish скрипт, например

      "scripts": {
        ...
        "prepublish": "npm run build"
      },
    
  5. .npmignore

    В данном файле записываем те ресурсы котоыре не будем публиковать, так-же, npm по умолчанию не будет публиковать файлы, которые находятся в .gitignore

  6. Публикация

    npm publish

npm
typescript
js
0
41