@urmzd/github-insights 2.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 urmzd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,188 @@
+<p align="center">
+  <h1 align="center">GitHub Insights</h1>
+  <p align="center">
+    Generate beautiful SVG insights visualizations for your GitHub profile README.
+    <br /><br />
+    <a href="https://github.com/urmzd/github-insights/releases">Install</a>
+    &middot;
+    <a href="https://github.com/urmzd/github-insights/issues">Report Bug</a>
+    &middot;
+    <a href="https://github.com/urmzd">Profile Demo</a>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://github.com/urmzd/github-insights/actions/workflows/ci.yml"><img src="https://github.com/urmzd/github-insights/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/urmzd/github-insights/actions/workflows/release.yml"><img src="https://github.com/urmzd/github-insights/actions/workflows/release.yml/badge.svg" alt="Release"></a>
+  <a href="https://github.com/urmzd/github-insights/issues"><img src="https://img.shields.io/github/issues/urmzd/github-insights" alt="Issues"></a>
+  <a href="https://github.com/urmzd/github-insights/pulls"><img src="https://img.shields.io/github/issues-pr/urmzd/github-insights" alt="Pull Requests"></a>
+  <a href="https://github.com/urmzd/github-insights/blob/main/LICENSE"><img src="https://img.shields.io/github/license/urmzd/github-insights" alt="License"></a>
+  <a href="https://www.npmjs.com/package/@urmzd/github-insights"><img src="https://img.shields.io/npm/v/@urmzd/github-insights" alt="npm version"></a>
+</p>
+
+![Example output](assets/insights/index.svg)
+
+## Features
+
+- **Language breakdown** — donut chart of languages by bytes across all public repos
+- **AI expertise analysis** — categorized skill bars with proficiency scores, powered by GitHub Models
+- **AI preamble generation** — auto-generated profile introduction (or supply your own `PREAMBLE.md`)
+- **Social badges** — auto-detected from your GitHub profile (website, Twitter, LinkedIn, etc.)
+- **Contribution pulse** — commits, PRs, reviews, and active repos at a glance
+- **Signature projects** — top repos by stars with descriptions
+- **Open source contributions** — external repos you've contributed to
+- **Configuration** — customize name, title, bio, and more via `github-insights.yml`
+
+## Quick Start
+
+Create `.github/workflows/metrics.yml` in your profile repository (`<username>/<username>`):
+
+```yaml
+name: Metrics
+on:
+  schedule:
+    - cron: "0 0 * * *" # daily
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  models: read
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: urmzd/github-insights@main
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+The action commits updated SVGs and a generated `README.md` to your repo automatically.
+
+## Inputs
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `github-token` | GitHub token (needs `repo` read + `models:read` for AI) | `${{ github.token }}` |
+| `username` | GitHub username to generate metrics for | `${{ github.repository_owner }}` |
+| `output-dir` | Directory to write SVG files to | `assets/insights` |
+| `commit-push` | Whether to commit and push generated files | `true` (CI) / `false` (local) |
+| `commit-message` | Commit message for generated files | `chore: update metrics` |
+| `commit-name` | Git user name for commits | `github-actions[bot]` |
+| `commit-email` | Git user email for commits | `41898282+github-actions[bot]@users.noreply.github.com` |
+| `config-file` | Path to config file | `github-insights.yml` |
+| `readme-path` | Output path for the generated profile README (set to `none` to skip) | `README.md` (CI) / `_README.md` (local) |
+| `index-only` | When `true`, embeds only the combined `index.svg` in the generated README; when `false`, embeds each section SVG as a separate image (e.g., `metrics-languages.svg`, `metrics-expertise.svg`, etc.) | `true` |
+
+## Configuration
+
+Create `github-insights.yml` (or `.yaml`) in your repo root:
+
+```yaml
+name: Your Name
+pronunciation: your-name
+title: Software Engineer
+desired_title: Senior Software Engineer
+bio: Building things on the internet.
+preamble: PREAMBLE.md  # path to custom preamble (optional)
+```
+
+All fields are optional. The `UserConfig` type in `src/types.ts` defines the full schema.
+
+> **Note:** The legacy config filename `.github-metrics.toml` (TOML format) is still supported but deprecated. Please migrate to `github-insights.yml`.
+
+## AI Features
+
+### Expertise Analysis
+
+The action uses GitHub Models to analyze your languages, dependencies, topics, and repo READMEs, then produces categorized skill bars with proficiency scores. Requires the `models:read` permission on your token.
+
+### Preamble Generation
+
+When no custom preamble is provided, the action uses AI to generate a profile introduction. The generated preamble consists of 2-4 short paragraphs drawn from your profile bio, title, expertise areas, top languages, and notable projects. It uses a professional but friendly tone and does not include a heading.
+
+The preamble ends with a row of shields.io social badges for any detected links — website, Twitter/X, LinkedIn, and other social accounts from your GitHub profile. A GitHub badge is not included since the README is already on GitHub.
+
+To use your own text instead, create a `PREAMBLE.md` file in the repo root, or point to a custom file via the `preamble` field in `github-insights.yml`.
+
+### Token Permissions
+
+For AI features, your workflow needs:
+
+```yaml
+permissions:
+  contents: write  # to commit generated files
+  models: read     # for AI expertise analysis and preamble generation
+```
+
+## Templates
+
+Four built-in templates control the generated README layout:
+
+| Template | Description |
+|----------|-------------|
+| `classic` | Name heading, title blockquote, preamble, SVG metrics, bio footer |
+| `modern` | Wave greeting, social badges, projects by activity (Active/Maintained/Inactive), GitHub Stats, expertise |
+| `minimal` | First name heading, preamble, social badges, SVG metrics |
+| `ecosystem` | Wave greeting, social badges, projects by purpose (Developer Tools/SDKs/Applications/Research), GitHub Stats, expertise |
+
+Set via the `template` input (default: `classic`) or `github-insights.yml`:
+
+```yaml
+- uses: urmzd/github-insights@v1
+  with:
+    template: ecosystem
+```
+
+The **ecosystem** template groups projects into purpose-based tables using AI classification, matching the layout used by [urmzd's profile README](https://github.com/urmzd).
+
+## Local Development
+
+### Prerequisites
+
+- Node.js 22+
+- `gh` CLI (authenticated) for local generation
+
+### Commands
+
+```sh
+npm run ci          # full CI check (fmt, lint, typecheck, test, build)
+npm run generate    # generate metrics locally (uses gh auth token)
+npm run build       # build ncc bundle
+npm test            # run tests
+npm run typecheck   # type-check
+npm run lint        # lint
+npm run fmt         # format check
+npm run fmt:fix     # format fix
+```
+
+> **Note:** When running locally (outside CI), `commit-push` defaults to `false` and `readme-path` defaults to `_README.md`, so `npm run generate` will not overwrite your project README or push commits.
+
+## Output Files
+
+| File | Description |
+|------|-------------|
+| `assets/insights/index.svg` | Combined visualization with all sections |
+| `assets/insights/metrics-pulse.svg` | Contribution activity stats |
+| `assets/insights/metrics-languages.svg` | Language breakdown donut chart |
+| `assets/insights/metrics-expertise.svg` | AI-generated expertise bars |
+| `assets/insights/metrics-complexity.svg` | Top projects by stars |
+| `assets/insights/metrics-contributions.svg` | External open source contributions |
+| `README.md` | Generated profile README (CI); `_README.md` locally |
+
+## Agent Skill
+
+This project ships an [Agent Skill](https://github.com/vercel-labs/skills) for use with Claude Code, Cursor, and other compatible agents.
+
+**Install:**
+
+```sh
+npx skills add urmzd/github-insights
+```
+
+Once installed, use `/github-insights` to generate and customize SVG profile metrics.
+
+---
+
+<sub>Created using [@urmzd/github-insights](https://github.com/urmzd/github-insights)</sub>

package/action.yml

@@ -0,0 +1,45 @@
+name: "GitHub Insights"
+description: "Generate SVG insights visualizations for your GitHub profile README"
+branding:
+  icon: "bar-chart-2"
+  color: "blue"
+inputs:
+  github-token:
+    description: "GitHub token (needs repo read + models:read for AI domain analysis)"
+    default: ${{ github.token }}
+  username:
+    description: "GitHub username to generate metrics for"
+    default: ${{ github.repository_owner }}
+  output-dir:
+    description: "Directory to write SVG files to"
+    default: "assets/insights"
+  commit-push:
+    description: "Whether to commit and push generated files"
+    default: "true"
+  commit-message:
+    description: "Commit message when committing generated files"
+    default: "chore: update metrics"
+  commit-name:
+    description: "Git user name for commits"
+    default: "github-actions[bot]"
+  commit-email:
+    description: "Git user email for commits"
+    default: "41898282+github-actions[bot]@users.noreply.github.com"
+  config-file:
+    description: "Path to github-insights.yml config file (also accepts .yaml or legacy .github-metrics.toml)"
+    default: "github-insights.yml"
+  readme-path:
+    description: "Output path for the generated profile README (set to 'none' to skip; defaults to _README.md locally)"
+    default: "README.md"
+  index-only:
+    description: "Embed only the combined index.svg; when false, embeds each section SVG individually"
+    default: "true"
+  template:
+    description: "README template to use: classic, modern, minimal, or ecosystem"
+    default: "classic"
+  sections:
+    description: "Comma-separated list of sections to generate (e.g. pulse,languages,expertise,projects,contributions,calendar). Empty = all."
+    default: ""
+runs:
+  using: "node24"
+  main: "dist/index.js"

package/biome.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.14/schema.json",
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 80
+  },
+  "javascript": {
+    "formatter": {
+      "trailingCommas": "all"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedVariables": {
+          "level": "error",
+          "fix": "none"
+        },
+        "noUnusedImports": "off"
+      },
+      "a11y": {
+        "noSvgWithoutTitle": "off"
+      }
+    }
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  "files": {
+    "includes": ["src/**", "!!**/dist/", "!!**/node_modules/"]
+  }
+}

package/examples/classic/README.md

@@ -0,0 +1,9 @@
+# Urmzd Mukhammadnaim
+
+I build robust, multi-language systems—from AI-powered CLI tools and resume generators in Go, Rust, and TypeScript to privacy-first agents and knowledge graphs—empowering people with scalable, user-centric tech.
+
+[![urmzd.com](https://img.shields.io/badge/urmzd.com-4285F4?style=flat&logo=google-chrome&logoColor=white)](https://urmzd.com) [![@urmzd_](https://img.shields.io/badge/@urmzd__-000000?style=flat&logo=x&logoColor=white)](https://x.com/urmzd_) [![urmzd](https://img.shields.io/badge/urmzd-0A66C2?style=flat&logo=linkedin&logoColor=white)](https://linkedin.com/in/urmzd)
+
+![GitHub Metrics](./index.svg)
+
+<sub>Last generated on 2026-03-16 using [@urmzd/github-insights](https://github.com/urmzd/github-insights)</sub>