نحوه ایجاد و انتشار یک کتابخانه TypeScript به راحتی

git clone https://github.com/amelspahic/typescript-library-template.git

npm install

npm run build

npm run fix

npm run test

TypeScript یک زبان محبوب و تاثیرگذار است که جاوا اسکریپت را با تایپ ایستا و سایر ویژگی ها گسترش می دهد. این می تواند به شما کمک کند تا کد قابل اعتمادتر، قابل نگهداری و مقیاس پذیرتر برای پروژه های خود بنویسید. با این حال، ایجاد و انتشار یک کتابخانه TypeScript می تواند چالش برانگیز باشد، به خصوص اگر شما تازه وارد اکوسیستم TypeScript هستید. ابزارها و پیکربندی‌های زیادی درگیر هستند، و یافتن یک الگو یا راهنمای خوب که همه چیزهایی را که نیاز دارید را پوشش دهد، چالش برانگیز است.

به دلایلی که در بالا ذکر شد، من یک الگوی کتابخانه TypeScript ایجاد کردم که می توانید از آن به عنوان نقطه شروع برای کتابخانه خود استفاده کنید. این بر اساس تجربه و بهترین شیوه‌های من از انجمن TypeScript است (این معمولاً ذهنی است)، و شامل همه چیزهایی است که برای توسعه، آزمایش، مستندسازی و انتشار کتابخانه‌تان نیاز دارید. در این مقاله توضیح خواهیم داد که این الگو چه چیزی را ارائه می دهد، چگونه از آن استفاده کنید و چگونه آن را برای نیازهای خود سفارشی کنید.

typescript-library-template چیست؟

typescript-library-template یک مخزن GitHub است که می توانید از آن به عنوان یک الگو برای ایجاد کتابخانه TypeScript خود استفاده کنید. دارای ویژگی های زیر است:

• TypeScript: به عنوان زبان اصلی برای نوشتن کد کتابخانه شما. همچنین شامل برخی از تنظیمات توصیه شده برای tsconfig.json و tslint.json فایل ها.

• AVA: به عنوان چارچوب آزمایشی برای نوشتن و اجرای تست های واحد برای کتابخانه شما. همچنین از گزارش های پوشش کد با استانبول (NYC) پشتیبانی می کند.

• Typedoc: به عنوان تولید کننده اسناد برای ایجاد اسناد API برای کتابخانه شما از نظرات TypeScript شما.

• زیباتر: به عنوان فرمت کننده کد برای ثابت و خوانا نگه داشتن سبک کد شما.

• ESLint (typescript-eslint): برای تجزیه و تحلیل کد استاتیک.

• Husky و Lint-staged: این الگو از Husky و Lint-staged برای اجرای قلاب‌های پیش‌فرض استفاده می‌کند که اطمینان حاصل می‌کند که کد شما قبل از انجام، قالب‌بندی، پرده، تست و مستند شده است.

چگونه از typescript-library-template استفاده کنیم؟

من فقط به چند دستور زیر اشاره می کنم. اطلاعات بیشتر را می توانید در فایل README.md بیابید.

استفاده از typescript-library-template بسیار آسان است. شما باید این مراحل را دنبال کنید:

• روی دکمه “استفاده از این الگو” در صفحه مخزن GitHub کلیک کنید. این یک مخزن جدید بر اساس این الگو در حساب شما ایجاد می کند.

• مخزن جدید خود را شبیه سازی کنید یا در دستگاه محلی خود دانلود کنید.

• اجرا کن npm install یا yarn install برای نصب تمام وابستگی ها

• توسعه کتابخانه خود را با ویرایش شروع کنید src/index.ts فایل (یا اضافه کردن فایل های بیشتر در زیر src). با استفاده از نحو AVA، می توانید تست های واحد را با استفاده از آن بنویسید .spec.ts یا .test.ts پسوندها

• اجرا کن npm run build یا yarn build برای ساخت کتابخانه شما این باعث ایجاد چندین فایل خروجی در زیر می شود dist پوشه

• را اجرا کنید npm run test یا yarn test برای اجرای تمام تست های واحد با استفاده از AVA.

• برای ایجاد گزارش پوشش کد در پوشه پوشش، اجرا کنید npm run cov.

• اجرا کن npm run doc یا yarn doc برای تولید اسناد API با استفاده از Typedoc. این یک فایل HTML در زیر ایجاد می کند docs/index.html.

• اجرا کن npm run fix یا yarn fix برای قالب بندی تمام فایل های منبع با استفاده از Prettier.

• تغییرات خود را متعهد کنید (یک قلاب از پیش commit را فعال می کند که آزمایش و پرده/قالب بندی را انجام می دهد)

• تغییرات خود را به GitHub فشار دهید.

چگونه تایپ اسکریپت-کتابخانه-قالب را سفارشی کنیم؟

شما می توانید تایپ اسکریپت-کتابخانه-قالب را با توجه به ترجیحات خود سفارشی کنید. فایل‌ها را اضافه کنید، پیکربندی‌ها را تغییر دهید، و هر چیزی را که به دلخواه خود بی‌اهمیت می‌دانید حذف کنید.