dwkim 0.0.17 → 0.0.18

package/README.md

@@ -249,6 +249,64 @@ jobs:
 
 ---
 
+## 11. NPM 배포 시 꼭 알아야 할 실무 팁
+
+### 1. dist만 NPM에 포함시키기
+
+- `package.json`에 아래처럼 **files 필드**를 추가하면, NPM 배포 시 dist 폴더만 포함됩니다.
+
+```json
+"files": [
+  "dist"
+]
+```
+
+- 또는, `.npmignore` 파일을 만들어 불필요한 파일/폴더를 명시적으로 제외할 수 있습니다.
+  (단, files 필드가 있으면 files가 우선 적용됨)
+
+예시:
+
+```
+src/
+test/
+.github/
+.vscode/
+*.ts
+*.md
+!dist/
+```
+
+### 2. bin 필드와 shebang
+
+- CLI로 실행하려면 `package.json`에 아래처럼 **bin 필드**를 추가해야 합니다.
+
+```json
+"bin": {
+  "dwkim": "dist/index.js"
+}
+```
+
+- 그리고 `src/index.ts`의 맨 위에 아래와 같이 **shebang**을 추가해야 합니다.
+
+```typescript
+#!/usr/bin/env node
+```
+
+- 빌드 후(`dist/index.js`)에도 이 줄이 남아 있어야 하며, 실행 권한도 확인하세요.
+
+### 3. 빌드 후 배포
+
+- 반드시 `pnpm run build`로 dist 폴더가 생성된 후에 배포해야 합니다.
+- release 스크립트에 build가 포함되어 있는지 확인하세요.
+
+### 4. .gitignore vs .npmignore
+
+- `.gitignore`: git에 포함하지 않을 파일
+- `.npmignore`: npm publish 시 포함하지 않을 파일 (없으면 .gitignore를 참고)
+- **files 필드가 있으면 files가 최우선 적용**
+
+---
+
 ## 참고
 
 - [예제 저장소 ↗]

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+declare function multiply(a: number, b: number): number;
+declare function identitiy<T>(arg: T): T;
+
+export { identitiy, multiply };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+declare function multiply(a: number, b: number): number;
+declare function identitiy<T>(arg: T): T;
+
+export { identitiy, multiply };

package/dist/index.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  identitiy: () => identitiy,
+  multiply: () => multiply
+});
+module.exports = __toCommonJS(index_exports);
+function multiply(a, b) {
+  return a * b;
+}
+function identitiy(arg) {
+  return arg;
+}
+function main() {
+  console.log("multiply 1 2", multiply(1, 2));
+  console.log("identitiy 1", identitiy("1"));
+}
+main();
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  identitiy,
+  multiply
+});

package/dist/index.mjs

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+// src/index.ts
+function multiply(a, b) {
+  return a * b;
+}
+function identitiy(arg) {
+  return arg;
+}
+function main() {
+  console.log("multiply 1 2", multiply(1, 2));
+  console.log("identitiy 1", identitiy("1"));
+}
+main();
+export {
+  identitiy,
+  multiply
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dwkim",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "this",
   "license": "MIT",
   "author": "dannyworks102@gmail.com",
@@ -8,6 +8,13 @@
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "bin": {
+    "dwkim": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
   "dependencies": {
     "typescript": "^5.8.3"
   },

package/.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "public",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/.github/workflows/main.yml

@@ -1,21 +0,0 @@
-name: CI - lint & build
-on:
-  push:
-    branches:
-      - '**'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 9
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'pnpm'
-
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm run lint && pnpm run build

package/.github/workflows/publish.yml

@@ -1,36 +0,0 @@
-name: Publish
-on:
-  workflow_run:
-    workflows: [CI - lint & build]
-    branches: [main]
-    types: [completed]
-
-concurrency: ${{ github.workflow }}-${{ github.ref }}
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  publish:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 9
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 20.x
-          cache: 'pnpm'
-
-      - run: pnpm install --frozen-lockfile
-      - name: Create Release Pull Request or Publish
-        id: changesets
-        uses: changesets/action@v1
-        with:
-          publish: pnpm publish --no-git-checks
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,14 +0,0 @@
-# dwkim
-
-## 0.0.3
-
-### Patch Changes
-
-- e433534: docs: README.md 및 .changeset/config.json 업데이트
-
-## 0.0.2
-
-### Patch Changes
-
-- 1cf9909: chore: @changesets/cli 추가
-- 1cf9909: chore: tsx 및 dev 스크립트 추가

package/src/index.ts

@@ -1,14 +0,0 @@
-export function multiply(a: number, b: number): number {
-  return a * b;
-}
-
-export function identitiy<T>(arg: T): T {
-  return arg;
-}
-
-function main() {
-  console.log('multiply 1 2', multiply(1, 2));
-  console.log('identitiy 1', identitiy('1'));
-}
-
-main();

package/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-    /* Language and Environment */
-    "target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-    "moduleDetection": "force" /* Control what method is used to detect module-format JS files. */,
-    "verbatimModuleSyntax": true,
-    "moduleResolution": "Bundler", // gonna use tsup
-    "module": "ESNext",
-
-    "lib": ["es2022", "dom", "dom.iterable"],
-
-    /* Modules */
-    "resolveJsonModule": true /* Enable importing .json files. */,
-
-    /* JavaScript Support */
-    "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
-
-    /* Emit */
-    "noEmit": true /* Disable emitting files from a compilation. */,
-
-    /* Interop Constraints */
-    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-
-    /* Type Checking */
-    "strict": true /* Enable all strict type-checking options. */,
-
-    /* Completeness */
-    "skipLibCheck": true /* Skip type checking all .d.ts files. */
-  }
-}