Merge pull request #202 from ysk8hori/feature/metrics-diff

feat: show-metrics :true を指定することでメトリクスを表示する

Author: ysk8hori

.github/workflows/test-dummy_project.yml

@@ -13,7 +13,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - name: Delta Typescript Graph
         id: tsg
-        uses: ysk8hori/delta-typescript-graph-action@7d17376b59ac5d63b67aabd79c614535da4ebbfd
+        uses: ysk8hori/delta-typescript-graph-action@3a2463ae804a9c18d42b98e22a4ed12ba14c265a
         with:
           access-token: ${{ secrets.GITHUB_TOKEN }}
           tsconfig: './dummy_project/tsconfig-dummy.json'
@@ -22,3 +22,4 @@ jobs:
           debug: true
           include-index-file-dependencies: true
           comment-title: 'Dummy project dependency graph'
+          show-metrics: true

.github/workflows/test-no-params.yml

@@ -11,6 +11,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-      - uses: ysk8hori/delta-typescript-graph-action@7d17376b59ac5d63b67aabd79c614535da4ebbfd
+      - uses: ysk8hori/delta-typescript-graph-action@3a2463ae804a9c18d42b98e22a4ed12ba14c265a
         with:
           max-size: 50

.github/workflows/test-with-params.yml

@@ -13,14 +13,15 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - name: Delta Typescript Graph
         id: tsg
-        uses: ysk8hori/delta-typescript-graph-action@7d17376b59ac5d63b67aabd79c614535da4ebbfd
+        uses: ysk8hori/delta-typescript-graph-action@3a2463ae804a9c18d42b98e22a4ed12ba14c265a
         with:
           access-token: ${{ secrets.GITHUB_TOKEN }}
           tsconfig-root: './'
-          max-size: 3
+          max-size: 50
           orientation: LR
           debug: true
           in-details: true
           exclude: 'test'
           include-index-file-dependencies: true
           comment-title: 'Delta TSG with params'
+          show-metrics: true

README.md

@@ -123,6 +123,7 @@ This Action provides several parameters to customize its behavior. You can speci
 | `exclude`                         | `string`     | `'node_modules, test'`   | Specifies a comma-separated list of files to exclude from the graph.                                                       |
 | `include-index-file-dependencies` | `boolean`    | `false`                  | Determines whether to display dependency files when the changed file is referenced from an index.ts in the same directory. |
 | `comment-title`                   | `string`     | `Delta TypeScript Graph` | Specifies the title of the comment posted on the PR. Useful for distinguishing analyses in monorepos or multiple CI runs.  |
+| `show-metrics`                    | `boolean`    | `false`                  | Specifies whether to calculate and display metrics for the graph.                                                          |
 
 To use these parameters, include them under the `with` section of your workflow file when using this Action. For example:
 
@@ -138,6 +139,7 @@ steps:
       in-details: true
       exclude: 'node_modules, test'
       include-index-file-dependencies: true
+      show-metrics: true
 ```
 
 This configuration will set up the Action with the specified parameters, allowing you to customize its behavior according to your project's needs.
@@ -148,3 +150,12 @@ Using the `tsg` command found in the comments generated by this action, you can
 
 For more information about the `tsg` command, please refer to the following repository:
 https://github.com/ysk8hori/typescript-graph
+
+## About the metrics
+
+This is a beta feature for measuring code metrics, including the Maintainability Index and Cognitive Complexity, among others.  
+While these metrics are widely recognized, their accuracy in TypeScript-specific contexts may vary.  
+Nonetheless, they can serve as helpful indicators for evaluating code quality.
+
+For more details, please refer to the TypeScript Graph README:  
+[TypeScript Graph README](https://github.com/ysk8hori/typescript-graph)

action.yml

@@ -41,6 +41,10 @@ inputs:
     description: 'Specifies the title of the comment posted on the PR.'
     required: false
     default: 'Delta TypeScript Graph'
+  show-metrics:
+    description: 'Calculate and display metrics for the graph'
+    required: false
+    default: false
 runs:
   using: 'node20'
   main: 'dist/index.js'