@d-zero/backlog-projects 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D-ZERO Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# `@d-zero/packbacklog-projects`
+
+## 使い方
+
+### プロジェクトアサイン
+
+```sh
+npx @d-zero/backlog-projects --assign
+```
+
+プロンプトに従って入力してください。
+
+```sh
+? BacklogのプロジェクトURLを入力してください ›
+? カテゴリーを入力してください（ガントチャートなどで管理しやすくなります） ›
+? 「窓口」を選択してください …
+? 「ディレクション」を選択してください …
+? 「情報設計」を選択してください …
+? 「ビジュアルデザイン」を選択してください …
+? 「フロントエンド」を選択してください …
+? 「システム」を選択してください …
+```
+
+逐次、課題が登録されます。
+
+```sh
+︙
+API_TEST-1190 メールフォーム 情報設計・項目定義 @DZ平尾
+API_TEST-1191 メールフォーム 自動返信メール文章作成 @DZ平尾
+API_TEST-1192 デモサイト+開発環境準備 @DZ平尾
+API_TEST-1193 トップページ デザイン @DZ平尾
+API_TEST-1194 トップページ デザイン クライアント確認 @DZ平尾
+API_TEST-1195 トップページ デザイン 戻し修正 @DZ平尾
+API_TEST-1196 下層ページ デザイン @DZ平尾
+︙
+
+🔗 https://xxxxx.backlog.jp/gantt/API_TEST?span=6&scale=days&grouping=3&startDate=2024/01/01
+```
+
+## `.env`ファイル
+
+`.env`ファイルを作成し、以下の内容を記述してください。
+
+```
+BACKLOG_HOST=xxxxx.backlog.jp
+BACKLOG_APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+NOTION_TOKEN=secret_xxxxxxxxxxxxxx
+```

package/dist/assign.d.ts

@@ -0,0 +1,11 @@
+import type { Role } from './types.js';
+import type { Backlog } from 'backlog-js';
+import type { Project, User } from 'backlog-js/dist/types/entity.js';
+type Params = {
+    backlogProject: Project.Project;
+    assignedUsers: Record<Role, User.User>;
+    backlogCategory?: string;
+    log?: (message: string) => void;
+};
+export declare function assign(backlog: Backlog, params: Params): Promise<void>;
+export {};

package/dist/assign.js

@@ -0,0 +1,67 @@
+import { NotionDB } from '@d-zero/notion';
+import { skipHolydayPeriod } from '@d-zero/shared/skip-holyday-period';
+import dayjs from 'dayjs';
+import { PROJECT_COMMON_TASK_LIST_NOTION_URL } from './define.js';
+export async function assign(backlog, params) {
+    if (!process.env.NOTION_TOKEN) {
+        throw new Error('NOTION_TOKEN is not defined. Please set it in .env file');
+    }
+    const project = params.backlogProject;
+    const assignedUsers = params.assignedUsers;
+    const categoryName = params.backlogCategory?.trim() ?? null;
+    const db = new NotionDB(process.env.NOTION_TOKEN, PROJECT_COMMON_TASK_LIST_NOTION_URL);
+    const data = await db.getTable({
+        sorts: [
+            {
+                property: '順番',
+                direction: 'ascending',
+            },
+        ],
+    });
+    if (!data['課題名']) {
+        return;
+    }
+    const categories = await backlog.getCategories(project.id);
+    const issueTypes = await backlog.getIssueTypes(project.id);
+    const issueTypeTask = issueTypes.find((t) => t.name === 'タスク') ?? issueTypes[0];
+    if (!issueTypeTask) {
+        throw new Error('issueTypes is not found');
+    }
+    const category = categoryName
+        ? categories.find((c) => c.name === categoryName) ??
+            (await backlog.postCategories(project.id, { name: categoryName }))
+        : null;
+    const now = dayjs();
+    let i = 0;
+    let currentDate = now.clone();
+    let interval = 0;
+    for (const value of data['課題名']) {
+        const days = +(data['工数（人日）']?.[i] || 1) - 1;
+        const { startDate, dueDate } = skipHolydayPeriod(currentDate, currentDate.add(days, 'day'));
+        const start = startDate.format('YYYY-MM-DD');
+        const due = dueDate.format('YYYY-MM-DD');
+        const role = data['担当']?.[i];
+        if (!role) {
+            throw new Error('role not found');
+        }
+        const assignedUser = assignedUsers[role];
+        const result = await backlog.postIssue({
+            projectId: project.id,
+            summary: value,
+            priorityId: 3,
+            issueTypeId: issueTypeTask.id,
+            startDate: start,
+            dueDate: due,
+            assigneeId: assignedUser.id,
+            categoryId: category ? [category.id] : [],
+        });
+        const realDays = dueDate.diff(startDate, 'day');
+        params.log?.(`${result.issueKey} ${result.summary} @${assignedUser.name}`);
+        interval = +(data['前工程との間隔（人日）']?.[i] || 0) + 1;
+        currentDate = currentDate.add(realDays + interval, 'day');
+        i++;
+    }
+    // https://xxx.backlog.jp/gantt/API_TEST?span=6&scale=days&grouping=3&startDate=2024/01/01
+    const resultUrl = `${backlog.webAppBaseURL}/gantt/${project.projectKey}?span=6&scale=days&grouping=3&startDate=${now.format('YYYY/MM/DD')}`;
+    params.log?.(`🔗 ${resultUrl}`);
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+import { Backlog } from 'backlog-js';
+import dotenv from 'dotenv';
+import Enquirer from 'enquirer';
+import minimist from 'minimist';
+import { assign } from './assign.js';
+import { roles } from './define.js';
+import { getBacklogProjectIdFromUrl } from './get-backlog-project-id-from-url.js';
+dotenv.config();
+const cli = minimist(process.argv.slice(2), {
+    alias: {
+        a: 'assign',
+    },
+});
+if (!process.env.BACKLOG_HOST) {
+    throw new Error('BACKLOG_HOST is not defined. Please set it in .env file');
+}
+if (!process.env.BACKLOG_APIKEY) {
+    throw new Error('BACKLOG_APIKEY is not defined. Please set it in .env file');
+}
+const backlog = new Backlog({
+    host: process.env.BACKLOG_HOST,
+    apiKey: process.env.BACKLOG_APIKEY,
+});
+if (cli.assign) {
+    const users = await backlog.getUsers();
+    const dzUsers = users.filter((u) => u.mailAddress.endsWith('@d-zero.co.jp'));
+    const { projectId } = await Enquirer.prompt({
+        name: 'projectId',
+        message: 'BacklogのプロジェクトURLを入力してください',
+        type: 'input',
+        required: true,
+        result(value) {
+            return getBacklogProjectIdFromUrl(value);
+        },
+    });
+    const project = await backlog.getProject(projectId);
+    const { category } = await Enquirer.prompt({
+        name: 'category',
+        message: 'カテゴリーを入力してください（ガントチャートなどで管理しやすくなります）',
+        type: 'input',
+        required: false,
+    });
+    const assignedUsers = {};
+    for (const role of roles) {
+        const { userName } = await Enquirer.prompt({
+            name: 'userName',
+            message: `「${role}」を選択してください`,
+            type: 'autocomplete',
+            required: true,
+            // @ts-ignore
+            limit: 5,
+            choices: dzUsers.map((u) => ({
+                name: u.name,
+                message: u.mailAddress,
+                hint: u.name,
+                value: u.name,
+            })),
+        });
+        const user = dzUsers.find((u) => u.name === userName);
+        if (!user) {
+            throw new Error(`User ${userName} is not found`);
+        }
+        assignedUsers[role] = user;
+    }
+    await assign(backlog, {
+        backlogProject: project,
+        backlogCategory: category || undefined,
+        assignedUsers: assignedUsers,
+        log(message) {
+            process.stdout.write(message + '\n');
+        },
+    });
+}

package/dist/define.d.ts

@@ -0,0 +1,3 @@
+import type { Role } from './types.js';
+export declare const PROJECT_COMMON_TASK_LIST_NOTION_URL = "https://www.notion.so/f4cdc643ebcb4221812bce6883e9422c?v=e09c94c1ab14487bb79833c076ba0998";
+export declare const roles: ReadonlySet<Role>;

package/dist/define.js

@@ -0,0 +1,9 @@
+export const PROJECT_COMMON_TASK_LIST_NOTION_URL = 'https://www.notion.so/f4cdc643ebcb4221812bce6883e9422c?v=e09c94c1ab14487bb79833c076ba0998';
+export const roles = new Set([
+    '窓口',
+    'ディレクション',
+    '情報設計',
+    'ビジュアルデザイン',
+    'フロントエンド',
+    'システム',
+]);

package/dist/get-backlog-project-id-from-url.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Extracts the project ID from a Backlog URL.
+ *
+ * Ex:
+ *  - https://xxx.backlog.jp/projects/API_TEST
+ *  - https://xxx.backlog.jp/add/API_TEST
+ *  - https://xxx.backlog.jp/find/API_TEST?projectId=123
+ *  - https://xxx.backlog.jp/board/API_TEST
+ *  - https://xxx.backlog.jp/gantt/API_TEST
+ *  - https://xxx.backlog.jp/wiki/API_TEST/Home
+ *  - https://xxx.backlog.jp/file/API_TEST
+ *  - https://xxx.backlog.jp/git/API_TEST
+ *  - https://xxx.backlog.jp/EditProject.action?project.id=123
+ *
+ * @param url
+ * @returns
+ */
+export declare function getBacklogProjectIdFromUrl(url: string): string;

package/dist/get-backlog-project-id-from-url.js

@@ -0,0 +1,40 @@
+/**
+ * Extracts the project ID from a Backlog URL.
+ *
+ * Ex:
+ *  - https://xxx.backlog.jp/projects/API_TEST
+ *  - https://xxx.backlog.jp/add/API_TEST
+ *  - https://xxx.backlog.jp/find/API_TEST?projectId=123
+ *  - https://xxx.backlog.jp/board/API_TEST
+ *  - https://xxx.backlog.jp/gantt/API_TEST
+ *  - https://xxx.backlog.jp/wiki/API_TEST/Home
+ *  - https://xxx.backlog.jp/file/API_TEST
+ *  - https://xxx.backlog.jp/git/API_TEST
+ *  - https://xxx.backlog.jp/EditProject.action?project.id=123
+ *
+ * @param url
+ * @returns
+ */
+export function getBacklogProjectIdFromUrl(url) {
+    try {
+        const urlObj = new URL(url);
+        const pathname = urlObj.pathname;
+        const paths = pathname.split('/').filter((p) => p !== '');
+        const projectId = paths[1];
+        if (!projectId) {
+            const searchParams = urlObj.searchParams;
+            const projectId = searchParams.get('project.id');
+            if (!projectId) {
+                throw new Error(`Project ID not found in URL: ${url}`);
+            }
+            return projectId;
+        }
+        return projectId;
+    }
+    catch (error) {
+        if (error instanceof TypeError) {
+            return url;
+        }
+        throw error;
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1 @@
+export type Role = '窓口' | 'ディレクション' | '情報設計' | 'ビジュアルデザイン' | 'フロントエンド' | 'システム';

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,35 @@
+{
+	"name": "@d-zero/backlog-projects",
+	"version": "0.2.0",
+	"description": "A manipulating Backlog projects library",
+	"author": "D-ZERO",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"engines": {
+		"node": ">=22.1.0"
+	},
+	"type": "module",
+	"bin": {
+		"backlog-projects": "./dist/cli.js"
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"clean": "tsc --build --clean"
+	},
+	"dependencies": {
+		"@d-zero/notion": "1.0.0",
+		"@d-zero/shared": "0.2.0",
+		"backlog-js": "0.13.1",
+		"dayjs": "1.11.11",
+		"dotenv": "16.4.5",
+		"enquirer": "2.4.1",
+		"minimist": "1.2.8"
+	},
+	"gitHead": "db479312eb17afb95785928ae632814897943ba1"
+}