あなたの最初のオープンソースソフトウェアを書くこと

この記事は私の視点から初心者を助けるために書かれています.あなたがこの部分の何も反対しないならば、私はそれを尊重します.
あなたがこの記事を読み始める前に、私はちょうどあなたをそこに停止させてください.なぜ!あなたは尋ねました、そして、私は義務がありました.おめでとう!混乱!?あなたがこの作品をあなたの心のいくつかの部分に与えることに決めたならば、あなたはオープンソースに向かって第一歩を踏み出したいです、そして、私はそれに貢献することができて、本当にうれしいです.🥂
さて、今日は何か特別なものがあります.過去には、最大のオープンソースパッケージリポジトリ、すなわちNPMJSからパッケージを使用したかもしれません.今日、私はあなた自身のオープンソース・ノード・パッケージを書いて、それからNPMJSでそれを公開することがどれだけ簡単かをあなたに教えるつもりです.
物事をより簡単にするために、それをやりましょう.

🏗 すべてを設定する

すべての良いオープンソースプロジェクトには、信頼を構築するファイルが含まれます.例えば、行為のコードを持って、ガイドラインを提供して、適切なドキュメンテーションは長い道のりに行きます.さらに、我々はそのようなファイルについて話している間、ライセンスを忘れないでください.
私はオープンソースの自動化ツールやパッケージを書く経験がありますので、いつでもcooked あなたが1つのコマンドを使用してすべてを開始するために使用できる何かをアップ.しかし、その前に、フォルダを作成しましょうcross-path .cross-path ダーウィンパスにダーウィンパスをWin 32とWin 32に変換するNPMパッケージになります.
このフォルダ内を移動し、次のように入力します.

npx create-foss-files --javascript

これは、オープンソースプロジェクトのために必要とするすべてを前に進めています.

あなたが知っているように、私はまた、あなたがそれを読みたいならば、断片について書きました.
完了したら、このフォルダをあなたのvscodeまたは好ましいコードエディタで開き、contributing.md ファイル.

🎩 あなたのパッケージメタデータを書く

作成されたファイルはpackage.json ファイル.このファイルにプロジェクトのメタデータがすべて含まれていることを確認します.開きます.
その中に多くの空のフィールドが表示されます.一つずついっぱいにしなさい.あなたのパッケージに名前、説明、バージョンなどを与えてください.クロスプラットフォームのパスを生成するためにパッケージを書いているので、名前を付けますcross-path , パッケージの機能性を説明して、他のものにも記入してください.
ファイルは次のようになります.

{
    "name": "cross-paths",
    "version": "1.0.0",
    "description": "Converts paths from darwin to win32 platform and vice versa",
    "repository": "https://github.com/msaaddev/cross-paths",
    "author": {
        "name": "Saad Irfan",
        "email": "[email protected]",
        "url": "https://twitter.com/msaaddev"
    },
    "main": "index.js",
    "license": "MIT",
    "scripts": {
        "format": "prettier --write \"./**/*.{js,json}\"",
    },
    "keywords": [
        "cross paths",
        "windows to unix paths",
        "unix to windows path",
        "darwin to windows path",
        "windows to darwin path",
        "path converter",
        "convert paths",
        "Saad Irfan",
        "msaaddev"
    ],
    "devDependencies": {
        "prettier": "^2.3.2"
    },
}

人々がNPMJsにあなたのパッケージを見つけることができるように、あなたがパッケージしているパッケージに関連したパッケージに適切なキーワードを与えるようにしてください.

💻 ステップ1

次のステップは、一部の人々もコードを呼ぶ魔法を書くことです.開けるindex.js ファイル.私はそれがパッケージからパッケージに変化するので、プロセスのこの部分であなたの時間を無駄にするつもりはありません.
しかし、私はまだこのコードを共有していますcross-path パッケージ.

/**
 *
 * Author: Saad Irfan
 * GitHub: msaaddev
 * Twitter: https://twitter.com/msaaddev
 */

const logSymbols = require('log-symbols');
const nodePath = require('path');
const { toUnix } = require('upath');

/**
 *
 *
 * @param {path} - darwin path
 * @returns {path} - win32 path
 */
const darwinToWin32 = path => {
    if (!path) {
        console.log(`${logSymbols.error} Please provide a valid path`);
        return null;
    }
    return nodePath.win32.normalize(path);
};

/**
 *
 *
 * @param {path} - win32 path
 * @returns {path} - darwin path
 */
const win32ToDarwin = path => {
    if (!path) {
        console.log(`${logSymbols.error} Please provide a valid path`);
        return null;
    }
    return toUnix(path);
};

module.exports = {
    darwinToWin32,
    win32ToDarwin
};

私があなたに説明する必要がある1つの非常に重要なものがあります.何を知っている必要がありますmodule.exports です.
‼️ module.exports あなたがそれに等しいセット何かをエクスポートします.これを通してファイルから変数(変数、オブジェクト、配列、関数、クラス)をエクスポートし、モジュールとしてエクスポートします.上記のコードを見ると、オブジェクトをエクスポートしていることに気づくでしょうmodule.exports . オブジェクトは2つの関数を含みます.それで、順番に、私はオブジェクトを通してこのファイルから2つの機能を輸出しています.
他の人がパッケージを通して使用したい機能/sをこのオブジェクトの中に入れてください.本文を読むarticle 理解を深めるmodule.exports .
使えますmodule.exports 複数のファイル間でコードをモジュール化するにはこれは、コードベースの読みやすさに役立ちます.
エクスポートするすべてのモジュールは、require キーワード.⚡️
あなたが気づいたかどうか、私はわかりません、しかし、私は上記のコードで3つの他のパッケージを使用しています.私はそれに私のインポートindex.js ファイルを使うrequire キーワード.あなたが知っているように、これは誰かが彼らのプロジェクトでコードを使用する方法です.

📖 ステップ・モード

一旦パッケージをコーディングするならば、人々が実際にあなたのパッケージを使うことができるように、良いドキュメンテーションを書いてください.ドキュメントはどんなプロジェクトの成功においても重要な役割を果たします.
この目的のためにreadme.md ファイルのような機能、インストールガイド、使用方法、あなたが重要であると思う他の情報を書くなど.

🎯 ステップ・アンド・ログイン

あなたのパッケージを公開する前に、最初にサインアップする必要がありますnpmjs.com . だから先に行くとこれを行う.
終了したら、端末を開き、以下のコマンドを入力します.

npm login

あなたのユーザー名、電子メール、パスワードなどの質問の束を求められます.今すぐあなたのコンピュータ端末はあなたのNPMJSアカウントに接続されています.

🚀 ステップ1

あなたが今必要とする最後のものはNPMJsにあなたのパッケージを公開することです.このためには、プロジェクト端末を開く必要があります.

npm publish

このコマンドを実行してプロジェクトを公開します.そして、それはすべてです.あなたは正常にそこに最大のプラットフォームの最初のオープンソースソフトウェアを公開している.

⚠️ 共通エラー

あなたのオープンソースパッケージを公開している間、あなたが見るかもしれない一般的な誤りのいくつかをあなたに話して、このポストは完了することができません.
パッケージを公開しようとすると、エラーになります.これらの2つの理由のいずれかによることができます.

同じ名前のパッケージが既に存在します.この場合、パッケージの名前を変更するか、スコープスコープのパッケージを作成する必要があります.スコープのパッケージについての詳細を読むhere .

再度公開する前に、パッケージのバージョン番号を更新していません.毎回変更を行って、パッケージを再度公開しているので、そのバージョンを変更する必要があります.既存のバージョンでは公開できません.私は以下を提案するsemantic versioning .

私は、テストを書くことについて話さなかったということを知っています.それは私ができるだけ初心者指向のこの作品を作ろうとしたからです.
私はすべての開発者は、キーボードのいくつかのストロークを介して魔法を生成することができます魔術師です(多分いくつかではないが、アイデアを得る).私も少し魔法を試してみました.そのうちの一つはnew-tailwind-app それはあなたが1つのコマンドを使用してTailwind統合されたWebアプリケーションを起動することができます.あなたは私のプロジェクトの詳細を見ることができますhere . あなたがその中にいる間、必ず私についてきてください.🙌🏻
チェリオ🤞🏻