aidescribe 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +25 -0
- package/dist/cli.mjs +17 -0
- package/package.json +61 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Paul Guilbert
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# aidescribe
|
|
2
|
+
|
|
3
|
+
CLI that generates [Jujutsu](https://jj-vcs.github.io/jj/) change descriptions with AI.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -g aidescribe
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Config
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
aidescribe config set provider=anthropic anthropic.apiKey=sk-ant-...
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# describe current change
|
|
21
|
+
aidescribe
|
|
22
|
+
|
|
23
|
+
# describe parent change
|
|
24
|
+
aidescribe -r @-
|
|
25
|
+
```
|
package/dist/cli.mjs
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
var V=Object.defineProperty;var s=(e,t)=>V(e,"name",{value:t,configurable:!0});import{command as W,cli as J}from"cleye";import{spinner as A,intro as U,outro as j,cancel as q,text as G,isCancel as Y}from"@clack/prompts";import v from"node:fs/promises";import z from"node:os";import H from"node:path";import{z as c}from"zod";import{createOpenAI as Q}from"@ai-sdk/openai";import{createAnthropic as X}from"@ai-sdk/anthropic";import{generateText as Z}from"ai";import{execa as w}from"execa";let m=!0;const u=typeof self<"u"?self:typeof window<"u"?window:typeof global<"u"?global:{};let h=0;if(u.process&&u.process.env&&u.process.stdout){const{FORCE_COLOR:e,NODE_DISABLE_COLORS:t,NO_COLOR:o,TERM:i,COLORTERM:n}=u.process.env;t||o||e==="0"?m=!1:e==="1"||e==="2"||e==="3"?m=!0:i==="dumb"?m=!1:"CI"in u.process.env&&["TRAVIS","CIRCLECI","APPVEYOR","GITLAB_CI","GITHUB_ACTIONS","BUILDKITE","DRONE"].some(a=>a in u.process.env)?m=!0:m=process.stdout.isTTY,m&&(process.platform==="win32"||n&&(n==="truecolor"||n==="24bit")?h=3:i&&(i.endsWith("-256color")||i.endsWith("256"))?h=2:h=1)}let D={enabled:m,supportLevel:h};function O(e,t,o=1){const i=`\x1B[${e}m`,n=`\x1B[${t}m`,a=new RegExp(`\\x1b\\[${t}m`,"g");return r=>D.enabled&&D.supportLevel>=o?i+(""+r).replace(a,i)+n:""+r}s(O,"kolorist");const ee=O(30,39),te=O(101,49),ie=s(async e=>{try{return await v.access(e),!0}catch{return!1}},"fileExists");class l extends Error{static{s(this,"KnownError")}}const I=s(e=>{if(e instanceof l&&(process.stderr.write(`aidescribe: ${e.message}
|
|
3
|
+
`),process.exit(1)),e instanceof Error){const t=e.stack??e.message;process.stderr.write(`aidescribe: ${t}
|
|
4
|
+
`),process.exit(1)}process.stderr.write(`aidescribe: ${String(e)}
|
|
5
|
+
`),process.exit(1)},"handleCommandError"),ne="gpt-5-mini",oe="claude-3-5-haiku-latest",d={provider:"openai",locale:"en",type:"conventional",maxLength:72,maxDiffChars:4e4,"openai.apiKey":void 0,"openai.model":ne,"anthropic.apiKey":void 0,"anthropic.model":oe},se=["provider","locale","type","maxLength","maxDiffChars","openai.apiKey","openai.model","anthropic.apiKey","anthropic.model"],re=["openai.apiKey","anthropic.apiKey"],C=s(e=>se.includes(e),"isConfigKey"),b=s(e=>({apiKey:e[`${e.provider}.apiKey`],model:e[`${e.provider}.model`]}),"getActiveProviderConfig"),$=s(()=>H.join(z.homedir(),".aidescribe.json"),"getConfigPath"),ae=s(e=>typeof e=="object"&&e!==null&&!Array.isArray(e),"isRecord"),S=c.object({provider:c.string().transform(e=>e.trim().toLowerCase()).pipe(c.enum(["openai","anthropic"])).optional(),locale:c.string().transform(e=>e.trim()).pipe(c.string().regex(/^[a-z-]+$/i,'must match letters and dashes (e.g. "en")')).optional(),type:c.string().transform(e=>e.trim()).pipe(c.enum(["conventional","plain"])).optional(),maxLength:c.union([c.number(),c.string().transform(e=>Number(e.trim()))]).pipe(c.number().int().positive({message:"must be a positive integer"})).optional(),maxDiffChars:c.union([c.number(),c.string().transform(e=>Number(e.trim()))]).pipe(c.number().int().positive({message:"must be a positive integer"})).optional(),"openai.apiKey":c.string().transform(e=>e.trim()).pipe(c.string().min(1)).optional(),"openai.model":c.string().transform(e=>e.trim()).pipe(c.string().min(1)).optional(),"anthropic.apiKey":c.string().transform(e=>e.trim()).pipe(c.string().min(1)).optional(),"anthropic.model":c.string().transform(e=>e.trim()).pipe(c.string().min(1)).optional()}),ce=s(e=>{const t=S.safeParse(e),o=t.success?t.data:{};return{provider:o.provider??d.provider,locale:o.locale??d.locale,type:o.type??d.type,maxLength:o.maxLength??d.maxLength,maxDiffChars:o.maxDiffChars??d.maxDiffChars,"openai.apiKey":o["openai.apiKey"],"openai.model":o["openai.model"]??d["openai.model"],"anthropic.apiKey":o["anthropic.apiKey"],"anthropic.model":o["anthropic.model"]??d["anthropic.model"]}},"parseConfig"),E=s(async()=>{const e=$();if(!await ie(e))return{};const o=await v.readFile(e,"utf8");try{const i=JSON.parse(o);if(!ae(i))throw new l(`Invalid config file format at ${e}. Expected a JSON object.`);for(const n of Object.keys(i))if(!C(n))throw new l(`Invalid config key "${n}" in ${e}. Supported keys: ${Object.keys(d).join(", ")}.`);return i}catch(i){throw i instanceof l?i:new l(`Invalid config file format at ${e}. Expected a JSON object.`)}},"readConfigFile"),R=s(async e=>{const o={...await E(),...e?.cliConfig};return ce(o)},"getConfig"),pe=s(e=>{const t=S.safeParse(e);if(!t.success){const o=t.error.issues[0],i=o?.path.join(".")||"config";throw new l(`Invalid ${i}: ${o?.message}`)}},"validateConfig"),le=s(async e=>{const t=await E();for(const[n,a]of e){if(!C(n))throw new l(`Invalid config property: ${n}`);a===""?delete t[n]:t[n]=a}pe(t);const o=$(),i=`${o}.${process.pid}.tmp`;await v.writeFile(i,`${JSON.stringify(t,null,2)}
|
|
6
|
+
`,"utf8"),await v.rename(i,o)},"setConfigs"),L=new Set(["-R","--repository","--at-operation","--at-op","--color","--config","--config-file"]),T=new Set(["--ignore-working-copy","--ignore-immutable","--debug","--quiet","--no-pager"]),fe=new Set(["-m","--message"]),de=new Set(["--stdin","--editor"]),K=new Set(["-r","--revision","--revisions","--revsets"]),me=s(e=>{const t=e.indexOf("=");return t<0?null:{key:e.slice(0,t),value:e.slice(t+1)}},"splitLongFlagWithEquals"),ue=s(e=>{const t=[],o=[];for(let i=0;i<e.length;i+=1){const n=e[i];if(n==="--"){o.push(...e.slice(i+1));break}if(n.startsWith("--")){const a=me(n);if(a){const{key:r,value:p}=a;if(K.has(r)){p&&o.push(p);continue}if(L.has(r)){t.push(n);continue}T.has(r)&&t.push(r);continue}if(K.has(n)){const r=e[i+1];r&&(o.push(r),i+=1);continue}if(L.has(n)){const r=e[i+1];r&&(t.push(n,r),i+=1);continue}if(T.has(n)){t.push(n);continue}if(fe.has(n)){i+=1;continue}if(de.has(n))continue;continue}if(n.startsWith("-")&&n!=="-"){if(n==="-r"){const a=e[i+1];a&&(o.push(a),i+=1);continue}if(n.startsWith("-r")&&n.length>2){o.push(n.slice(2));continue}if(n==="-R"){const a=e[i+1];a&&(t.push(n,a),i+=1);continue}if(n.startsWith("-R")&&n.length>2){t.push("-R",n.slice(2));continue}if(n==="-m"){i+=1;continue}if(n.startsWith("-m")&&n.length>2)continue;continue}o.push(n)}return{globalArgs:t,revsets:o}},"parseDescribeArgsForDiff"),N=new Set(["--ai-provider","--ai-locale","--ai-type","--ai-max-length","--ai-max-diff-chars"]),k=new Set(["--verbose"]),ge=s(e=>{const t=[];for(let o=0;o<e.length;o+=1){const i=e[o];if(i==="--"){t.push(...e.slice(o+1));break}const n=i.indexOf("=");if(n>0){const a=i.slice(0,n);if(N.has(a)||k.has(a))continue}if(N.has(i)){o+=1;continue}k.has(i)||t.push(i)}return t},"getForwardedJjDescribeArgs"),he=JSON.stringify({docs:"Documentation only changes",style:"Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",refactor:"A code change that improves code structure without changing functionality (renaming, restructuring classes/methods, extracting functions, etc)",perf:"A code change that improves performance",test:"Adding missing tests or correcting existing tests",build:"Changes that affect the build system or external dependencies",ci:"Changes to our CI configuration files and scripts",chore:"Other changes that don't modify src or test files",revert:"Reverts a previous commit",feat:"A new feature",fix:"A bug fix"},null,2),ye={conventional:`Choose a type from the type-to-description JSON below that best describes the git diff:
|
|
7
|
+
${he}`,plain:""},ve={conventional:"<type>[optional (<scope>)]: <commit message>",plain:"<commit message>"},we=s((e,t,o,i=[])=>["Generate a concise git commit message title in present tense that precisely describes the key changes in the following code diff. Focus on what was changed, not just file names. Provide only the title, no description or body.",`Message language: ${e}`,`Commit message must be a maximum of ${t} characters.`,"Exclude anything unnecessary such as translation. Your entire response will be passed directly into jj describe.",`IMPORTANT: Do not include any explanations, introductions, or additional text. Do not wrap the commit message in quotes or any other formatting. The commit message must not exceed ${t} characters. Respond with ONLY the commit message text.`,"Be specific: include concrete details (package names, versions, functionality) rather than generic statements.",i.length>0?["Current change description(s) for the target revision(s):",...i.slice(0,5).map((n,a)=>`${a+1}. ${n}`),"If one of these is still relevant, edit/improve it. If not relevant, replace it completely."].join(`
|
|
8
|
+
`):"",ye[o],`The output response must be in format:
|
|
9
|
+
${ve[o]}`].filter(Boolean).join(`
|
|
10
|
+
`),"generatePrompt"),be=s((e,t,o)=>{const i=b(e).model,n=["[aidescribe] AI request payload",`provider=${e.provider}`,`model=${i}`];e.provider==="openai"?(n.push("baseURL=https://api.openai.com/v1"),n.push("apiMode=openai-default")):(n.push("baseURL=https://api.anthropic.com/v1"),n.push("apiMode=anthropic-messages")),n.push("","[system]",t,"","[prompt]",o,""),process.stderr.write(`${n.join(`
|
|
11
|
+
`)}
|
|
12
|
+
`)},"printVerbosePayload"),xe=s((e,t,o)=>{const i=["[aidescribe] AI response payload",`finishReason=${t}`,`warnings=${o?JSON.stringify(o):"[]"}`,"","[response.text]",e||"<empty>",""];process.stderr.write(`${i.join(`
|
|
13
|
+
`)}
|
|
14
|
+
`)},"printVerboseResponse"),Ce=s((e,t)=>e.length>t?e.slice(0,t).trim():e,"truncateToLength"),$e=s(e=>{const{apiKey:t,model:o}=b(e);return(e.provider==="openai"?Q({apiKey:t}):X({apiKey:t}))(o)},"resolveModel"),Re=s(async(e,t,o)=>{const i=$e(t),n=await Z({model:i,maxRetries:2,system:o,prompt:e});return{rawText:n.text,finishReason:n.finishReason,warnings:n.warnings,reasoningText:n.reasoningText??""}},"generateWithProvider"),Ae=s(async(e,t,o)=>{const i=b(t);if(!i.apiKey)throw new l("apiKey is required.");const n=e.length>t.maxDiffChars?`${e.slice(-t.maxDiffChars)}
|
|
15
|
+
|
|
16
|
+
[Diff truncated due to size]`:e,a=we(t.locale,t.maxLength,t.type,o?.currentDescriptions??[]);o?.verbose&&be(t,a,n);let r;try{r=await Re(n,t,a)}catch(f){const g=f instanceof Error?f.message:String(f);throw new l(`AI request failed for provider "${t.provider}" (model "${i.model}"): ${g}`)}o?.verbose&&xe(r.rawText,r.finishReason,r.warnings);const p=r.rawText.trim();if(!p)throw new l(`AI returned an empty description (finishReason=${r.finishReason}). Re-run with --verbose to inspect provider output.`);return Ce(p,t.maxLength)},"generateDescription"),x="aidescribe-git-minimal",je=["--config",`merge-tools.${x}.program=git`,"--config",`merge-tools.${x}.diff-args=["diff","--no-index","--diff-algorithm=minimal","$left","$right"]`,"--config",`merge-tools.${x}.diff-expected-exit-codes=[0,1]`],F=s(e=>e.length>0?e.join("|"):"@","getTargetRevsetExpression"),P=s(e=>{const t=[...e];return e.includes("--no-pager")||t.push("--no-pager"),t},"buildBaseJjArgs"),De=s(async()=>{if((await w("jj",["root"],{reject:!1})).failed)throw new l("The current directory must be inside a jj repository.")},"assertJjRepo"),Oe=s(async e=>{const t=e?.globalArgs??[],o=e?.revsets??[],i=P(t);i.push(...je,"diff","--tool",x),o.length>0&&i.push("--revisions",F(o));const{stdout:n}=await w("jj",i);return n.trim()},"getDiff"),Ie=s(async e=>{const t=e?.globalArgs??[],o=e?.revsets??[],i=P(t);i.push("log","--no-graph","--revisions",F(o),"--template",'description.first_line() ++ "\\n"');const{stdout:n}=await w("jj",i),a=n.split(`
|
|
17
|
+
`).map(r=>r.trim()).filter(Boolean);return Array.from(new Set(a))},"getCurrentDescriptions"),Se=s(async(e,t)=>{await w("jj",["describe","-m",e,...t],{stdio:"inherit"})},"runJjDescribe"),Ee=s(async e=>{const t=await G({message:"Edit description",placeholder:e,initialValue:e,validate:s(o=>o.trim().length>0?void 0:"Description cannot be empty","validate")});return Y(t)?null:String(t).trim()},"reviewDescription");var Le=s(async(e,t)=>(async()=>{const o=A(),i=e.verbose?A():null;U(te(ee(" aidescribe \u2728 "))),i?.start("Checking repository"),await De(),i?.stop("Repository detected"),i?.start("Loading configuration");const n=await R({cliConfig:{provider:e.aiProvider,locale:e.aiLocale,type:e.aiType,maxLength:e.aiMaxLength,maxDiffChars:e.aiMaxDiffChars}});if(i?.stop("Configuration loaded"),!b(n).apiKey)throw new l(`apiKey is required for provider "${n.provider}". Set it with \`aidescribe config set ${n.provider}.apiKey=...\`.`);const a=ge(t),r=ue(a);i?.start("Reading `jj diff`");const p=await Oe(r);if(i?.stop("Diff collected"),!p){j("No changes found in `jj diff`. Skipping description update.");return}i?.start("Reading current description");const f=await Ie(r);i?.stop(f.length>0?"Current description loaded":"No current description found"),o.start("Generating description");const g=await Ae(p,n,{verbose:e.verbose,currentDescriptions:f});o.stop("Description generated");const y=await Ee(g);if(!y){q("Cancelled");return}const B=y;i?.start("Running `jj describe`"),await Se(B,a),i?.stop("Description applied"),j("Done")})().catch(I),"aidescribeCommand");const Te=s((e,t)=>{if(!re.includes(e))return String(t);const o=String(t);return o?o.length<=4?`${o}****`:`${o.slice(0,4)}****`:""},"maskValue"),Ke=["provider","openai.apiKey","openai.model","anthropic.apiKey","anthropic.model","locale","type","maxLength","maxDiffChars"],Ne=s((e,t)=>e[t],"getConfigValue"),_=s((e,t)=>{const o=Ne(e,t);console.log(`${t}=${Te(t,o??"")}`)},"printConfigEntry");var ke=W({name:"config",description:"View or modify configuration settings",help:{description:"View or modify configuration settings"},parameters:["[mode]","[keyValues...]"]},e=>{(async()=>{const t=Array.isArray(e._)?e._:[],[o,...i]=t,n=typeof o=="string"?o:void 0,a=i.filter(r=>typeof r=="string");if(!n){const r=await R();console.log(`Config file: ${$()}`);for(const p of Ke)_(r,p);return}if(n==="get"){const r=await R();for(const p of a)C(p)&&_(r,p);return}if(n==="set"){const r=a.map(p=>{const f=p.indexOf("=");if(f<0)throw new l(`Invalid key=value pair: ${p}. Use: aidescribe config set key=value`);const g=p.slice(0,f),y=p.slice(f+1);return[g,y]});await le(r);return}throw new l(`Invalid mode: ${n}. Use "get" or "set".`)})().catch(I)}),Fe="0.0.1",Pe="Generate jj change descriptions with AI",_e={version:Fe,description:Pe};const{description:Me,version:Be}=_e,M=process.argv.slice(2);J({name:"aidescribe",version:Be,flags:{aiProvider:{type:String,description:"Override provider for this run (supported: openai, anthropic)"},aiLocale:{type:String,description:"Override locale for this run (default: en)"},aiType:{type:String,description:"Message format for this run (default: conventional, supports: conventional, plain)"},aiMaxLength:{type:Number,description:"Max generated title length for this run (default: 72)"},aiMaxDiffChars:{type:Number,description:"Max diff chars sent to AI for this run (default: 40000)"},verbose:{type:Boolean,description:"Print the exact prompt payload sent to the AI model for this run",default:!1}},commands:[ke],help:{description:Me},ignoreArgv:s(e=>e==="unknown-flag"||e==="argument","ignoreArgv")},e=>{Le(e.flags,M)},M);
|
package/package.json
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "aidescribe",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Generate jj change descriptions with AI",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"ai",
|
|
7
|
+
"cli",
|
|
8
|
+
"commit",
|
|
9
|
+
"jj",
|
|
10
|
+
"jujutsu",
|
|
11
|
+
"vcs"
|
|
12
|
+
],
|
|
13
|
+
"homepage": "https://github.com/pguilbert/aidescribe#readme",
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/pguilbert/aidescribe/issues"
|
|
16
|
+
},
|
|
17
|
+
"license": "MIT",
|
|
18
|
+
"author": "Paul Guilbert",
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "https://github.com/pguilbert/aidescribe.git"
|
|
22
|
+
},
|
|
23
|
+
"bin": {
|
|
24
|
+
"aidescribe": "dist/cli.mjs"
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"dist"
|
|
28
|
+
],
|
|
29
|
+
"type": "module",
|
|
30
|
+
"scripts": {
|
|
31
|
+
"build": "pkgroll --minify",
|
|
32
|
+
"typecheck": "tsc",
|
|
33
|
+
"dev": "tsx src/cli.ts",
|
|
34
|
+
"prepack": "npm run build",
|
|
35
|
+
"fmt": "oxfmt",
|
|
36
|
+
"fmt:check": "oxfmt --check",
|
|
37
|
+
"lint": "oxlint",
|
|
38
|
+
"lint:fix": "oxlint --fix"
|
|
39
|
+
},
|
|
40
|
+
"dependencies": {
|
|
41
|
+
"@ai-sdk/anthropic": "^2.0.0",
|
|
42
|
+
"@ai-sdk/openai": "^3.0.5",
|
|
43
|
+
"@clack/prompts": "^0.10.1",
|
|
44
|
+
"ai": "^6.0.13",
|
|
45
|
+
"cleye": "^2.0.0",
|
|
46
|
+
"execa": "^7.0.0",
|
|
47
|
+
"zod": "^4.3.6"
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@types/node": "^24.3.0",
|
|
51
|
+
"kolorist": "^1.8.0",
|
|
52
|
+
"oxfmt": "^0.35.0",
|
|
53
|
+
"oxlint": "^1.50.0",
|
|
54
|
+
"pkgroll": "^2.22.1",
|
|
55
|
+
"tsx": "^4.20.6",
|
|
56
|
+
"typescript": "^5.9.3"
|
|
57
|
+
},
|
|
58
|
+
"engines": {
|
|
59
|
+
"node": ">=22"
|
|
60
|
+
}
|
|
61
|
+
}
|