@soybeanjs/changelog 0.3.3 → 0.3.5
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/dist/index.cjs +22 -15
- package/dist/index.d.cts +63 -122
- package/dist/index.d.mts +63 -122
- package/dist/index.d.ts +63 -122
- package/dist/index.mjs +22 -15
- package/package.json +28 -22
package/dist/index.cjs
CHANGED
|
@@ -1,19 +1,26 @@
|
|
|
1
|
-
"use strict";const cliProgress=require("cli-progress"),promises=require("fs/promises"),ofetch=require("ofetch"),
|
|
2
|
-
`)
|
|
3
|
-
|
|
4
|
-
`).
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
"use strict";const cliProgress=require("cli-progress"),r=require("node:process"),promises=require("node:fs/promises"),ofetch=require("ofetch"),A=require("dayjs"),node_fs=require("node:fs"),convertGitmoji=require("convert-gitmoji");function _interopDefaultCompat(o){return o&&typeof o=="object"&&"default"in o?o.default:o}const r__default=_interopDefaultCompat(r),A__default=_interopDefaultCompat(A),LogLevels={silent:Number.NEGATIVE_INFINITY,fatal:0,error:0,warn:1,log:2,info:3,success:3,fail:3,ready:3,start:3,box:3,debug:4,trace:5,verbose:Number.POSITIVE_INFINITY},LogTypes={silent:{level:-1},fatal:{level:LogLevels.fatal},error:{level:LogLevels.error},warn:{level:LogLevels.warn},log:{level:LogLevels.log},info:{level:LogLevels.info},success:{level:LogLevels.success},fail:{level:LogLevels.fail},ready:{level:LogLevels.info},start:{level:LogLevels.info},box:{level:LogLevels.info},debug:{level:LogLevels.debug},trace:{level:LogLevels.trace},verbose:{level:LogLevels.verbose}};function isObject(o){return o!==null&&typeof o=="object"}function _defu(o,t,e=".",s){if(!isObject(t))return _defu(o,{},e,s);const n=Object.assign({},t);for(const i in o){if(i==="__proto__"||i==="constructor")continue;const a=o[i];a!=null&&(s&&s(n,i,a,e)||(Array.isArray(a)&&Array.isArray(n[i])?n[i]=[...a,...n[i]]:isObject(a)&&isObject(n[i])?n[i]=_defu(a,n[i],(e?`${e}.`:"")+i.toString(),s):n[i]=a))}return n}function createDefu(o){return(...t)=>t.reduce((e,s)=>_defu(e,s,"",o),{})}const defu=createDefu();function isPlainObject(o){return Object.prototype.toString.call(o)==="[object Object]"}function isLogObj(o){return!(!isPlainObject(o)||!o.message&&!o.args||o.stack)}let paused=!1;const queue=[];class Consola{constructor(t={}){const e=t.types||LogTypes;this.options=defu({...t,defaults:{...t.defaults},level:_normalizeLogLevel(t.level,e),reporters:[...t.reporters||[]]},{types:LogTypes,throttle:1e3,throttleMin:5,formatOptions:{date:!0,colors:!1,compact:!0}});for(const s in e){const n={type:s,...this.options.defaults,...e[s]};this[s]=this._wrapLogFn(n),this[s].raw=this._wrapLogFn(n,!0)}this.options.mockFn&&this.mockTypes(),this._lastLog={}}get level(){return this.options.level}set level(t){this.options.level=_normalizeLogLevel(t,this.options.types,this.options.level)}prompt(t,e){if(!this.options.prompt)throw new Error("prompt is not supported!");return this.options.prompt(t,e)}create(t){const e=new Consola({...this.options,...t});return this._mockFn&&e.mockTypes(this._mockFn),e}withDefaults(t){return this.create({...this.options,defaults:{...this.options.defaults,...t}})}withTag(t){return this.withDefaults({tag:this.options.defaults.tag?this.options.defaults.tag+":"+t:t})}addReporter(t){return this.options.reporters.push(t),this}removeReporter(t){if(t){const e=this.options.reporters.indexOf(t);if(e>=0)return this.options.reporters.splice(e,1)}else this.options.reporters.splice(0);return this}setReporters(t){return this.options.reporters=Array.isArray(t)?t:[t],this}wrapAll(){this.wrapConsole(),this.wrapStd()}restoreAll(){this.restoreConsole(),this.restoreStd()}wrapConsole(){for(const t in this.options.types)console["__"+t]||(console["__"+t]=console[t]),console[t]=this[t].raw}restoreConsole(){for(const t in this.options.types)console["__"+t]&&(console[t]=console["__"+t],delete console["__"+t])}wrapStd(){this._wrapStream(this.options.stdout,"log"),this._wrapStream(this.options.stderr,"log")}_wrapStream(t,e){t&&(t.__write||(t.__write=t.write),t.write=s=>{this[e].raw(String(s).trim())})}restoreStd(){this._restoreStream(this.options.stdout),this._restoreStream(this.options.stderr)}_restoreStream(t){t&&t.__write&&(t.write=t.__write,delete t.__write)}pauseLogs(){paused=!0}resumeLogs(){paused=!1;const t=queue.splice(0);for(const e of t)e[0]._logFn(e[1],e[2])}mockTypes(t){const e=t||this.options.mockFn;if(this._mockFn=e,typeof e=="function")for(const s in this.options.types)this[s]=e(s,this.options.types[s])||this[s],this[s].raw=this[s]}_wrapLogFn(t,e){return(...s)=>{if(paused){queue.push([this,t,s,e]);return}return this._logFn(t,s,e)}}_logFn(t,e,s){if((t.level||0)>this.level)return!1;const n={date:new Date,args:[],...t,level:_normalizeLogLevel(t.level,this.options.types)};!s&&e.length===1&&isLogObj(e[0])?Object.assign(n,e[0]):n.args=[...e],n.message&&(n.args.unshift(n.message),delete n.message),n.additional&&(Array.isArray(n.additional)||(n.additional=n.additional.split(`
|
|
2
|
+
`)),n.args.push(`
|
|
3
|
+
`+n.additional.join(`
|
|
4
|
+
`)),delete n.additional),n.type=typeof n.type=="string"?n.type.toLowerCase():"log",n.tag=typeof n.tag=="string"?n.tag:"";const i=(c=!1)=>{const l=(this._lastLog.count||0)-this.options.throttleMin;if(this._lastLog.object&&l>0){const u=[...this._lastLog.object.args];l>1&&u.push(`(repeated ${l} times)`),this._log({...this._lastLog.object,args:u}),this._lastLog.count=1}c&&(this._lastLog.object=n,this._log(n))};clearTimeout(this._lastLog.timeout);const a=this._lastLog.time&&n.date?n.date.getTime()-this._lastLog.time.getTime():0;if(this._lastLog.time=n.date,a<this.options.throttle)try{const c=JSON.stringify([n.type,n.tag,n.args]),l=this._lastLog.serialized===c;if(this._lastLog.serialized=c,l&&(this._lastLog.count=(this._lastLog.count||0)+1,this._lastLog.count>this.options.throttleMin)){this._lastLog.timeout=setTimeout(i,this.options.throttle);return}}catch{}i(!0)}_log(t){for(const e of this.options.reporters)e.log(t,{options:this.options})}}function _normalizeLogLevel(o,t={},e=3){return o===void 0?e:typeof o=="number"?o:t[o]&&t[o].level!==void 0?t[o].level:e}Consola.prototype.add=Consola.prototype.addReporter,Consola.prototype.remove=Consola.prototype.removeReporter,Consola.prototype.clear=Consola.prototype.removeReporter,Consola.prototype.withScope=Consola.prototype.withTag,Consola.prototype.mock=Consola.prototype.mockTypes,Consola.prototype.pause=Consola.prototype.pauseLogs,Consola.prototype.resume=Consola.prototype.resumeLogs;function createConsola$1(o={}){return new Consola(o)}class BrowserReporter{constructor(t){this.options={...t},this.defaultColor="#7f8c8d",this.levelColorMap={0:"#c0392b",1:"#f39c12",3:"#00BCD4"},this.typeColorMap={success:"#2ecc71"}}_getLogFn(t){return t<1?console.__error||console.error:t===1?console.__warn||console.warn:console.__log||console.log}log(t){const e=this._getLogFn(t.level),s=t.type==="log"?"":t.type,n=t.tag||"",a=`
|
|
5
|
+
background: ${this.typeColorMap[t.type]||this.levelColorMap[t.level]||this.defaultColor};
|
|
6
|
+
border-radius: 0.5em;
|
|
7
|
+
color: white;
|
|
8
|
+
font-weight: bold;
|
|
9
|
+
padding: 2px 0.5em;
|
|
10
|
+
`,c=`%c${[n,s].filter(Boolean).join(":")}`;typeof t.args[0]=="string"?e(`${c}%c ${t.args[0]}`,a,"",...t.args.slice(1)):e(c,a,...t.args)}}function createConsola(o={}){return createConsola$1({reporters:o.reporters||[new BrowserReporter({})],prompt(e,s={}){return s.type==="confirm"?Promise.resolve(confirm(e)):Promise.resolve(prompt(e))},...o})}const consola=createConsola();async function execCommand(o,t,e){const{execa:s}=await import("execa");return(await s(o,t,e))?.stdout?.trim()||""}function notNullish(o){return o!=null}function partition(o,...t){const e=Array.from({length:t.length+1}).fill(null).map(()=>[]);return o.forEach((s,n,i)=>{let a=0;for(const c of t){if(c(s,n,i)){e[a].push(s);return}a+=1}e[a].push(s)}),e}function groupBy(o,t,e={}){for(const s of o){const n=s[t];e[n]||(e[n]=[]),e[n].push(s)}return e}function capitalize(o){return o.charAt(0).toUpperCase()+o.slice(1)}function join(o,t=", ",e=" and "){return!o||o.length===0?"":o.length===1?o[0]:o.length===2?o.join(e):`${o.slice(0,-1).join(t)}${e}${o.slice(-1)}`}const VERSION_REG=/v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/,VERSION_REG_OF_MARKDOWN=/## \[v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?]/g,VERSION_WITH_RELEASE=/release\sv\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/;async function getTotalGitTags(){return(await execCommand("git",["--no-pager","tag","-l","--sort=creatordate"])).split(`
|
|
11
|
+
`)}async function getTagDateMap(){const o=await execCommand("git",["--no-pager","log","--tags","--simplify-by-decoration","--pretty=format:%ci %d"]),t="tag: ",e=new Map;return o.split(`
|
|
12
|
+
`).filter(s=>s.includes(t)).forEach(s=>{const[n,i]=s.split(t),a=A__default(n).format("YYYY-MM-DD"),c=i.match(VERSION_REG)?.[0];c&&a&&e.set(c.trim(),a)}),e}function getFromToTags(o){const t=[];return o.forEach((e,s)=>{s<o.length-1&&t.push({from:e,to:o[s+1]})}),t}async function getLastGitTag(o=0){const t=await getTotalGitTags();return t[t.length+o-1]}async function v$1(){return await execCommand("git",["rev-parse","--abbrev-ref","HEAD"])}async function getCurrentGitBranch(){const o=await execCommand("git",["tag","--points-at","HEAD"]),t=v$1();return o||t}async function getGitHubRepo(){const o=await execCommand("git",["config","--get","remote.origin.url"]),t=o.match(/github\.com[/:]([\w\d._-]+?)\/([\w\d._-]+?)(\.git)?$/i);if(!t)throw new Error(`Can not parse GitHub repo from url ${o}`);return`${t[1]}/${t[2]}`}function isPrerelease(o){return!/^[^.]*[\d.]+$/.test(o)}function getFirstGitCommit(){return execCommand("git",["rev-list","--max-parents=0","HEAD"])}async function E(o,t="HEAD"){return(await execCommand("git",["--no-pager","log",`${o?`${o}...`:""}${t}`,'--pretty="----%n%s|%h|%an|%ae%n%b"',"--name-status"])).split(`----
|
|
13
|
+
`).splice(1).map(e=>{const[s,...n]=e.split(`
|
|
14
|
+
`),[i,a,c,l]=s.split("|");return{message:i,shortHash:a,author:{name:c,email:l},body:n.join(`
|
|
15
|
+
`)}})}function x$1(o){const t=/(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i,e=/co-authored-by:\s*(?<name>.+)(<(?<email>.+)>)/gim,s=/\([a-z]*(#\d+)\s*\)/gm,n=/(#\d+)/gm,i=o.message.match(t);if(!i?.groups)return null;const a=i.groups.type,c=i.groups.scope||"",l=!!i.groups.breaking;let u=i.groups.description;const p=[];for(const g of u.matchAll(s))p.push({type:"pull-request",value:g[1]});for(const g of u.matchAll(n))p.some(_=>_.value===g[1])||p.push({type:"issue",value:g[1]});p.push({value:o.shortHash,type:"hash"}),u=u.replace(s,"").trim();const m=[o.author],f=o.body.matchAll(e);for(const g of f){const{name:_="",email:b=""}=g.groups||{},F={name:_.trim(),email:b.trim()};m.push(F)}return{...o,authors:m,resolvedAuthors:[],description:u,type:a,scope:c,references:p,isBreaking:l}}async function getGitCommits(o,t="HEAD"){return(await E(o,t)).map(e=>x$1(e)).filter(notNullish)}function C(o){return{accept:"application/vnd.github.v3+json",authorization:`token ${o}`}}async function $(o,t,e){let s="";try{s=(await ofetch.ofetch(`https://ungh.cc/users/find/${e}`))?.user?.username||""}catch(a){consola.log("e: ",a)}if(s)return s;const{repo:n,token:i}=o;if(!i)return s;if(t.length)try{s=(await ofetch.ofetch(`https://api.github.com/repos/${n}/commits/${t[0]}`,{headers:C(i)}))?.author?.login||""}catch(a){consola.log("e: ",a)}if(s)return s;try{s=(await ofetch.ofetch(`https://api.github.com/search/users?q=${encodeURIComponent(e)}`,{headers:C(i)})).items[0].login}catch(a){consola.log("e: ",a)}return s}async function getGitCommitsAndResolvedAuthors(o,t,e){const s=[],n=new Map;for await(const i of o){const a=[];for await(const[l,u]of i.authors.entries()){const{email:p,name:m}=u;if(p&&m){const f=[];l===0&&f.push(i.shortHash);const g={name:m,email:p,commits:f,login:""};if(e?.has(p)){const _=e?.get(p)||"";g.login=_}else{const _=await $(t,f,p);g.login=_,e?.set(p,_)}a.push(g),n.has(p)||n.set(p,g)}}const c={...i,resolvedAuthors:a};s.push(c)}return{commits:s,contributors:Array.from(n.values())}}function w(){return{cwd:r__default.cwd(),types:{feat:"\u{1F680} Features",fix:"\u{1F41E} Bug Fixes",perf:"\u{1F525} Performance",refactor:"\u{1F485} Refactors",docs:"\u{1F4D6} Documentation",build:"\u{1F4E6} Build",types:"\u{1F30A} Types",chore:"\u{1F3E1} Chore",examples:"\u{1F3C0} Examples",test:"\u2705 Tests",style:"\u{1F3A8} Styles",ci:"\u{1F916} CI"},github:{repo:"",token:r__default.env.GITHUB_TOKEN||""},from:"",to:"",tags:[],tagDateMap:new Map,capitalize:!1,emoji:!0,titles:{breakingChanges:"\u{1F6A8} Breaking Changes"},output:"CHANGELOG.md",regenerate:!1,newVersion:""}}async function h(o){let t="";try{const e=await promises.readFile(`${o}/package.json`,"utf-8");t=JSON.parse(e)?.version||""}catch{}return{newVersion:t}}async function createOptions(o){var t;const e=w();Object.assign(e,o);const{newVersion:s}=await h(e.cwd);if((t=e.github).repo||(t.repo=await getGitHubRepo()),e.newVersion||(e.newVersion=`v${s}`),e.from||(e.from=await getLastGitTag()),e.to||(e.to=await getCurrentGitBranch()),e.to===e.from){const n=await getLastGitTag(-1),i=await getFirstGitCommit();e.from=n||i}return e.tags=await getTotalGitTags(),e.tagDateMap=await getTagDateMap(),e.prerelease||(e.prerelease=isPrerelease(e.to)),e}function d(o,t,e){const s=o.filter(i=>e==="issues"?i.type==="issue"||i.type==="pull-request":i.type==="hash").map(i=>t?i.type==="pull-request"||i.type==="issue"?`https://github.com/${t}/issues/${i.value.slice(1)}`:`[<samp>(${i.value.slice(0,5)})</samp>](https://github.com/${t}/commit/${i.value})`:i.value),n=join(s).trim();return e==="issues"?n&&`in ${n}`:n}function j(o,t){const e=d(o.references,t.github.repo,"issues"),s=d(o.references,t.github.repo,"hash");let n=join([...new Set(o.resolvedAuthors.map(a=>a.login?`@${a.login}`:`**${a.name}**`))]).trim();n&&(n=`by ${n}`);let i=[n,e,s].filter(a=>a?.trim()).join(" ");return i&&(i=` - ${i}`),[t.capitalize?capitalize(o.description):o.description,i].filter(a=>a?.trim()).join(" ")}function G(o,t){const e=/([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;let s=o.trim();return t.emoji||(s=o.replace(e,"").trim()),`### ${s}`}function y(o,t,e){if(!o.length)return[];const s=["",G(t,e),""],n=groupBy(o,"scope");let i=!0;return Object.entries(n).some(([a,c])=>a&&c.length>1)||(i=!1),Object.keys(n).sort().forEach(a=>{let c="",l="";const u=`**${a}**`;a&&i?(s.push(`- ${u}:`),c=" "):a&&(l=`${u}: `),s.push(...n[a].reverse().map(p=>`${c}- ${l}${j(p,e)}`))}),s}function v(o){return`https://github.com/${o}`}function k(o){return`${v(o)}.png?size=48`}function x(o){let t="",e="";const s=new Map;return o.forEach(n=>{s.set(n.email,n)}),Array.from(s.values()).forEach((n,i)=>{const{name:a,email:c,login:l}=n;if(l){const u=v(l),p=k(l);t+=`[](${u}) `}else{let u=`[${a}](mailto:${c})`;i<o.length-1&&(u+=", "),e+=u}}),`${t}
|
|
16
|
+
${e}`}function generateMarkdown(o){const{options:t,showTitle:e,contributors:s}=o,n=o.commits.filter(f=>f.description.match(VERSION_WITH_RELEASE)===null),i=[],a=!VERSION_REG.test(t.to),c=a?t.newVersion:t.to,l=`https://github.com/${t.github.repo}/compare/${t.from}...${c}`;if(e){const f=a?A__default().format("YY-MM-DD"):t.tagDateMap.get(t.to);let g=`## [${c}](${l})`;f&&(g+=` (${f})`),i.push(g)}const[u,p]=partition(n,f=>f.isBreaking),m=groupBy(p,"type");i.push(...y(u,t.titles.breakingChanges,t));for(const f of Object.keys(t.types)){const g=m[f]||[];i.push(...y(g,t.types[f],t))}if(i.length||i.push("*No significant changes*"),e||i.push("",`##### [View changes on GitHub](${l})`),e){i.push("","### \u2764\uFE0F Contributors","");const f=x(s);i.push(f)}return convertGitmoji.convert(i.join(`
|
|
17
|
+
`).trim(),!0)}async function isVersionInMarkdown(o,t){let e=!1;const s=await promises.readFile(t,"utf8");if(s){const n=s.match(VERSION_REG_OF_MARKDOWN);if(n?.length){const i=`## [${o}]`;e=n.includes(i)}}return e}async function writeMarkdown(o,t,e=!1){let s="";const n="# Changelog";node_fs.existsSync(t)||await promises.writeFile(t,n,"utf8"),e||(s=await promises.readFile(t,"utf8")),s.startsWith(n)||(s=`${n}
|
|
9
18
|
|
|
10
|
-
${
|
|
19
|
+
${s}`);const i=s.match(/^###?\s+.*$/m);i?s+=`${s.slice(0,i.index)+o}
|
|
11
20
|
|
|
12
|
-
|
|
21
|
+
${s.slice(i.index)}`:s+=`
|
|
22
|
+
${o}
|
|
13
23
|
|
|
14
|
-
|
|
15
|
-
${t}
|
|
24
|
+
`,await promises.writeFile(t,s)}async function getChangelogMarkdown(o,t=!0){const e=await createOptions(o),s=await getGitCommits(e.from,e.to),{commits:n,contributors:i}=await getGitCommitsAndResolvedAuthors(s,e.github);return{markdown:generateMarkdown({commits:n,options:e,showTitle:t,contributors:i}),commits:n,options:e}}async function getTotalChangelogMarkdown(o,t=!0){const e=await createOptions(o);let s=null;t&&(s=new cliProgress.SingleBar({format:"generate total changelog: [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}"},cliProgress.Presets.shades_classic));const n=getFromToTags(e.tags);if(n.length===0){const{markdown:c}=await getChangelogMarkdown(e);return c}s?.start(n.length,0);let i="";const a=new Map;for await(const[c,l]of n.entries()){const{from:u,to:p}=l,m=await getGitCommits(u,p),{commits:f,contributors:g}=await getGitCommitsAndResolvedAuthors(m,e.github,a);i=`${generateMarkdown({commits:f,options:{...e,from:u,to:p},showTitle:!0,contributors:g})}
|
|
16
25
|
|
|
17
|
-
`,
|
|
18
|
-
|
|
19
|
-
${s}`,o?.update(i+1)}return o?.stop(),s}async function generateChangelog(t){const n=await createOptions(t),e=await isVersionInMarkdown(n.to,n.output);if(!n.regenerate&&e)return;const{markdown:o}=await getChangelogMarkdown(n);await writeMarkdown(o,n.output,n.regenerate)}async function generateTotalChangelog(t,n=!0){const e=await createOptions(t),o=await getTotalChangelogMarkdown(e,n);await writeMarkdown(o,e.output,!0)}exports.generateChangelog=generateChangelog,exports.generateTotalChangelog=generateTotalChangelog,exports.getChangelogMarkdown=getChangelogMarkdown,exports.getTotalChangelogMarkdown=getTotalChangelogMarkdown;
|
|
26
|
+
${i}`,s?.update(c+1)}return s?.stop(),i}async function generateChangelog(o){const t=await createOptions(o),e=await isVersionInMarkdown(t.to,t.output);if(!t.regenerate&&e)return;const{markdown:s}=await getChangelogMarkdown(t);await writeMarkdown(s,t.output,t.regenerate)}async function generateTotalChangelog(o,t=!0){const e=await createOptions(o),s=await getTotalChangelogMarkdown(e,t);await writeMarkdown(s,e.output,!0)}exports.generateChangelog=generateChangelog,exports.generateTotalChangelog=generateTotalChangelog,exports.getChangelogMarkdown=getChangelogMarkdown,exports.getTotalChangelogMarkdown=getTotalChangelogMarkdown;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,182 +1,120 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* the commit author
|
|
3
|
-
*/
|
|
1
|
+
/** The commit author */
|
|
4
2
|
interface GitCommitAuthor {
|
|
5
|
-
/**
|
|
6
|
-
* the author name
|
|
7
|
-
*/
|
|
3
|
+
/** The author name */
|
|
8
4
|
name: string;
|
|
9
|
-
/**
|
|
10
|
-
* the author email
|
|
11
|
-
*/
|
|
5
|
+
/** The author email */
|
|
12
6
|
email: string;
|
|
13
7
|
}
|
|
14
|
-
/**
|
|
15
|
-
* the raw git commit
|
|
16
|
-
*/
|
|
8
|
+
/** The raw git commit */
|
|
17
9
|
interface RawGitCommit {
|
|
18
|
-
/**
|
|
19
|
-
* the commit message
|
|
20
|
-
*/
|
|
10
|
+
/** The commit message */
|
|
21
11
|
message: string;
|
|
22
|
-
/**
|
|
23
|
-
* the commit body
|
|
24
|
-
*/
|
|
12
|
+
/** The commit body */
|
|
25
13
|
body: string;
|
|
26
|
-
/**
|
|
27
|
-
* the commit hash
|
|
28
|
-
*/
|
|
14
|
+
/** The commit hash */
|
|
29
15
|
shortHash: string;
|
|
30
|
-
/**
|
|
31
|
-
* the commit author
|
|
32
|
-
*/
|
|
16
|
+
/** The commit author */
|
|
33
17
|
author: GitCommitAuthor;
|
|
34
18
|
}
|
|
35
|
-
/**
|
|
36
|
-
* the reference of the commit
|
|
37
|
-
*/
|
|
19
|
+
/** The reference of the commit */
|
|
38
20
|
interface Reference {
|
|
39
|
-
/**
|
|
40
|
-
* the reference type
|
|
41
|
-
*/
|
|
21
|
+
/** The reference type */
|
|
42
22
|
type: 'hash' | 'issue' | 'pull-request';
|
|
43
|
-
/**
|
|
44
|
-
* the reference value
|
|
45
|
-
*/
|
|
23
|
+
/** The reference value */
|
|
46
24
|
value: string;
|
|
47
25
|
}
|
|
48
|
-
/**
|
|
49
|
-
* the resolved github author
|
|
50
|
-
*/
|
|
26
|
+
/** The resolved github author */
|
|
51
27
|
interface ResolvedAuthor extends GitCommitAuthor {
|
|
52
|
-
/**
|
|
53
|
-
* the git commit of the author
|
|
54
|
-
*/
|
|
28
|
+
/** The git commit of the author */
|
|
55
29
|
commits: string[];
|
|
56
|
-
/**
|
|
57
|
-
* the github logged username of the author
|
|
58
|
-
*/
|
|
30
|
+
/** The github logged username of the author */
|
|
59
31
|
login: string;
|
|
60
32
|
}
|
|
61
|
-
/**
|
|
62
|
-
* git commit config
|
|
63
|
-
*/
|
|
33
|
+
/** Git commit config */
|
|
64
34
|
interface GitCommit extends RawGitCommit {
|
|
65
|
-
/**
|
|
66
|
-
* the commit description
|
|
67
|
-
*/
|
|
35
|
+
/** The commit description */
|
|
68
36
|
description: string;
|
|
69
|
-
/**
|
|
70
|
-
* the commit scope type
|
|
71
|
-
*/
|
|
37
|
+
/** The commit scope type */
|
|
72
38
|
type: string;
|
|
73
|
-
/**
|
|
74
|
-
* the commit scope
|
|
75
|
-
*/
|
|
39
|
+
/** The commit scope */
|
|
76
40
|
scope: string;
|
|
77
|
-
/**
|
|
78
|
-
* the commit references
|
|
79
|
-
*/
|
|
41
|
+
/** The commit references */
|
|
80
42
|
references: Reference[];
|
|
81
|
-
/**
|
|
82
|
-
* the commit authors
|
|
83
|
-
*/
|
|
43
|
+
/** The commit authors */
|
|
84
44
|
authors: GitCommitAuthor[];
|
|
85
|
-
/**
|
|
86
|
-
* the resolved authors
|
|
87
|
-
*/
|
|
45
|
+
/** The resolved authors */
|
|
88
46
|
resolvedAuthors: ResolvedAuthor[];
|
|
89
|
-
/**
|
|
90
|
-
* the commit breaking changes
|
|
91
|
-
*/
|
|
47
|
+
/** The commit breaking changes */
|
|
92
48
|
isBreaking: boolean;
|
|
93
49
|
}
|
|
94
|
-
/**
|
|
95
|
-
* github config
|
|
96
|
-
*/
|
|
50
|
+
/** Github config */
|
|
97
51
|
interface GithubConfig {
|
|
98
52
|
/**
|
|
99
|
-
*
|
|
100
|
-
*
|
|
53
|
+
* The github repository name
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* soybeanjs / changelog;
|
|
101
57
|
*/
|
|
102
58
|
repo: string;
|
|
103
|
-
/**
|
|
104
|
-
* the github token
|
|
105
|
-
*/
|
|
59
|
+
/** The github token */
|
|
106
60
|
token: string;
|
|
107
61
|
}
|
|
108
62
|
interface ChangelogOption {
|
|
109
63
|
/**
|
|
110
|
-
*
|
|
64
|
+
* The directory of the project
|
|
65
|
+
*
|
|
111
66
|
* @default process.cwd()
|
|
112
67
|
*/
|
|
113
68
|
cwd: string;
|
|
114
|
-
/**
|
|
115
|
-
* the commit scope types
|
|
116
|
-
*/
|
|
69
|
+
/** The commit scope types */
|
|
117
70
|
types: Record<string, string>;
|
|
118
|
-
/**
|
|
119
|
-
* github config
|
|
120
|
-
*/
|
|
71
|
+
/** Github config */
|
|
121
72
|
github: GithubConfig;
|
|
122
|
-
/**
|
|
123
|
-
* the commit hash or tag
|
|
124
|
-
*/
|
|
73
|
+
/** The commit hash or tag */
|
|
125
74
|
from: string;
|
|
126
|
-
/**
|
|
127
|
-
* the commit hash or tag
|
|
128
|
-
*/
|
|
75
|
+
/** The commit hash or tag */
|
|
129
76
|
to: string;
|
|
130
|
-
/**
|
|
131
|
-
* the whole commit tags
|
|
132
|
-
*/
|
|
77
|
+
/** The whole commit tags */
|
|
133
78
|
tags: string[];
|
|
134
|
-
/**
|
|
135
|
-
* the commit tag and date map
|
|
136
|
-
*/
|
|
79
|
+
/** The commit tag and date map */
|
|
137
80
|
tagDateMap: Map<string, string>;
|
|
138
|
-
/**
|
|
139
|
-
* Whether to capitalize the first letter of the commit type
|
|
140
|
-
*/
|
|
81
|
+
/** Whether to capitalize the first letter of the commit type */
|
|
141
82
|
capitalize: boolean;
|
|
142
83
|
/**
|
|
143
84
|
* Use emojis in section titles
|
|
85
|
+
*
|
|
144
86
|
* @default true
|
|
145
87
|
*/
|
|
146
88
|
emoji: boolean;
|
|
147
|
-
/**
|
|
148
|
-
* the section titles
|
|
149
|
-
*/
|
|
89
|
+
/** The section titles */
|
|
150
90
|
titles: {
|
|
151
|
-
/**
|
|
152
|
-
* the title of breaking changes section
|
|
153
|
-
*/
|
|
91
|
+
/** The title of breaking changes section */
|
|
154
92
|
breakingChanges: string;
|
|
155
93
|
};
|
|
156
|
-
/**
|
|
157
|
-
* the output file path of the changelog
|
|
158
|
-
*/
|
|
94
|
+
/** The output file path of the changelog */
|
|
159
95
|
output: string;
|
|
160
96
|
/**
|
|
161
97
|
* Whether to regenerate the changelog if it already exists
|
|
162
|
-
*
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* the changelog already exists the content of v0.0.1, but you want to regenerate it
|
|
163
101
|
*/
|
|
164
102
|
regenerate: boolean;
|
|
165
103
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
104
|
+
* Version from package.json, with prefix "v"
|
|
105
|
+
*
|
|
106
|
+
* If the options "to" is not specified, the version will be used
|
|
168
107
|
*/
|
|
169
108
|
newVersion: string;
|
|
170
|
-
/**
|
|
171
|
-
* Mark the release as prerelease
|
|
172
|
-
*/
|
|
109
|
+
/** Mark the release as prerelease */
|
|
173
110
|
prerelease?: boolean;
|
|
174
111
|
}
|
|
175
112
|
|
|
176
113
|
/**
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
* @param
|
|
114
|
+
* Get the changelog markdown by two git tags
|
|
115
|
+
*
|
|
116
|
+
* @param options The changelog options
|
|
117
|
+
* @param showTitle Whither show the title
|
|
180
118
|
*/
|
|
181
119
|
declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTitle?: boolean): Promise<{
|
|
182
120
|
markdown: string;
|
|
@@ -184,20 +122,23 @@ declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTi
|
|
|
184
122
|
options: ChangelogOption;
|
|
185
123
|
}>;
|
|
186
124
|
/**
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
* @param
|
|
125
|
+
* Get the changelog markdown by the total git tags
|
|
126
|
+
*
|
|
127
|
+
* @param options The changelog options
|
|
128
|
+
* @param showProgress Whither show the progress bar
|
|
190
129
|
*/
|
|
191
130
|
declare function getTotalChangelogMarkdown(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<string>;
|
|
192
131
|
/**
|
|
193
|
-
*
|
|
194
|
-
*
|
|
132
|
+
* Generate the changelog markdown by two git tags
|
|
133
|
+
*
|
|
134
|
+
* @param options The changelog options
|
|
195
135
|
*/
|
|
196
136
|
declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<void>;
|
|
197
137
|
/**
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* @param
|
|
138
|
+
* Generate the changelog markdown by the total git tags
|
|
139
|
+
*
|
|
140
|
+
* @param options The changelog options
|
|
141
|
+
* @param showProgress Whither show the progress bar
|
|
201
142
|
*/
|
|
202
143
|
declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
|
|
203
144
|
|
package/dist/index.d.mts
CHANGED
|
@@ -1,182 +1,120 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* the commit author
|
|
3
|
-
*/
|
|
1
|
+
/** The commit author */
|
|
4
2
|
interface GitCommitAuthor {
|
|
5
|
-
/**
|
|
6
|
-
* the author name
|
|
7
|
-
*/
|
|
3
|
+
/** The author name */
|
|
8
4
|
name: string;
|
|
9
|
-
/**
|
|
10
|
-
* the author email
|
|
11
|
-
*/
|
|
5
|
+
/** The author email */
|
|
12
6
|
email: string;
|
|
13
7
|
}
|
|
14
|
-
/**
|
|
15
|
-
* the raw git commit
|
|
16
|
-
*/
|
|
8
|
+
/** The raw git commit */
|
|
17
9
|
interface RawGitCommit {
|
|
18
|
-
/**
|
|
19
|
-
* the commit message
|
|
20
|
-
*/
|
|
10
|
+
/** The commit message */
|
|
21
11
|
message: string;
|
|
22
|
-
/**
|
|
23
|
-
* the commit body
|
|
24
|
-
*/
|
|
12
|
+
/** The commit body */
|
|
25
13
|
body: string;
|
|
26
|
-
/**
|
|
27
|
-
* the commit hash
|
|
28
|
-
*/
|
|
14
|
+
/** The commit hash */
|
|
29
15
|
shortHash: string;
|
|
30
|
-
/**
|
|
31
|
-
* the commit author
|
|
32
|
-
*/
|
|
16
|
+
/** The commit author */
|
|
33
17
|
author: GitCommitAuthor;
|
|
34
18
|
}
|
|
35
|
-
/**
|
|
36
|
-
* the reference of the commit
|
|
37
|
-
*/
|
|
19
|
+
/** The reference of the commit */
|
|
38
20
|
interface Reference {
|
|
39
|
-
/**
|
|
40
|
-
* the reference type
|
|
41
|
-
*/
|
|
21
|
+
/** The reference type */
|
|
42
22
|
type: 'hash' | 'issue' | 'pull-request';
|
|
43
|
-
/**
|
|
44
|
-
* the reference value
|
|
45
|
-
*/
|
|
23
|
+
/** The reference value */
|
|
46
24
|
value: string;
|
|
47
25
|
}
|
|
48
|
-
/**
|
|
49
|
-
* the resolved github author
|
|
50
|
-
*/
|
|
26
|
+
/** The resolved github author */
|
|
51
27
|
interface ResolvedAuthor extends GitCommitAuthor {
|
|
52
|
-
/**
|
|
53
|
-
* the git commit of the author
|
|
54
|
-
*/
|
|
28
|
+
/** The git commit of the author */
|
|
55
29
|
commits: string[];
|
|
56
|
-
/**
|
|
57
|
-
* the github logged username of the author
|
|
58
|
-
*/
|
|
30
|
+
/** The github logged username of the author */
|
|
59
31
|
login: string;
|
|
60
32
|
}
|
|
61
|
-
/**
|
|
62
|
-
* git commit config
|
|
63
|
-
*/
|
|
33
|
+
/** Git commit config */
|
|
64
34
|
interface GitCommit extends RawGitCommit {
|
|
65
|
-
/**
|
|
66
|
-
* the commit description
|
|
67
|
-
*/
|
|
35
|
+
/** The commit description */
|
|
68
36
|
description: string;
|
|
69
|
-
/**
|
|
70
|
-
* the commit scope type
|
|
71
|
-
*/
|
|
37
|
+
/** The commit scope type */
|
|
72
38
|
type: string;
|
|
73
|
-
/**
|
|
74
|
-
* the commit scope
|
|
75
|
-
*/
|
|
39
|
+
/** The commit scope */
|
|
76
40
|
scope: string;
|
|
77
|
-
/**
|
|
78
|
-
* the commit references
|
|
79
|
-
*/
|
|
41
|
+
/** The commit references */
|
|
80
42
|
references: Reference[];
|
|
81
|
-
/**
|
|
82
|
-
* the commit authors
|
|
83
|
-
*/
|
|
43
|
+
/** The commit authors */
|
|
84
44
|
authors: GitCommitAuthor[];
|
|
85
|
-
/**
|
|
86
|
-
* the resolved authors
|
|
87
|
-
*/
|
|
45
|
+
/** The resolved authors */
|
|
88
46
|
resolvedAuthors: ResolvedAuthor[];
|
|
89
|
-
/**
|
|
90
|
-
* the commit breaking changes
|
|
91
|
-
*/
|
|
47
|
+
/** The commit breaking changes */
|
|
92
48
|
isBreaking: boolean;
|
|
93
49
|
}
|
|
94
|
-
/**
|
|
95
|
-
* github config
|
|
96
|
-
*/
|
|
50
|
+
/** Github config */
|
|
97
51
|
interface GithubConfig {
|
|
98
52
|
/**
|
|
99
|
-
*
|
|
100
|
-
*
|
|
53
|
+
* The github repository name
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* soybeanjs / changelog;
|
|
101
57
|
*/
|
|
102
58
|
repo: string;
|
|
103
|
-
/**
|
|
104
|
-
* the github token
|
|
105
|
-
*/
|
|
59
|
+
/** The github token */
|
|
106
60
|
token: string;
|
|
107
61
|
}
|
|
108
62
|
interface ChangelogOption {
|
|
109
63
|
/**
|
|
110
|
-
*
|
|
64
|
+
* The directory of the project
|
|
65
|
+
*
|
|
111
66
|
* @default process.cwd()
|
|
112
67
|
*/
|
|
113
68
|
cwd: string;
|
|
114
|
-
/**
|
|
115
|
-
* the commit scope types
|
|
116
|
-
*/
|
|
69
|
+
/** The commit scope types */
|
|
117
70
|
types: Record<string, string>;
|
|
118
|
-
/**
|
|
119
|
-
* github config
|
|
120
|
-
*/
|
|
71
|
+
/** Github config */
|
|
121
72
|
github: GithubConfig;
|
|
122
|
-
/**
|
|
123
|
-
* the commit hash or tag
|
|
124
|
-
*/
|
|
73
|
+
/** The commit hash or tag */
|
|
125
74
|
from: string;
|
|
126
|
-
/**
|
|
127
|
-
* the commit hash or tag
|
|
128
|
-
*/
|
|
75
|
+
/** The commit hash or tag */
|
|
129
76
|
to: string;
|
|
130
|
-
/**
|
|
131
|
-
* the whole commit tags
|
|
132
|
-
*/
|
|
77
|
+
/** The whole commit tags */
|
|
133
78
|
tags: string[];
|
|
134
|
-
/**
|
|
135
|
-
* the commit tag and date map
|
|
136
|
-
*/
|
|
79
|
+
/** The commit tag and date map */
|
|
137
80
|
tagDateMap: Map<string, string>;
|
|
138
|
-
/**
|
|
139
|
-
* Whether to capitalize the first letter of the commit type
|
|
140
|
-
*/
|
|
81
|
+
/** Whether to capitalize the first letter of the commit type */
|
|
141
82
|
capitalize: boolean;
|
|
142
83
|
/**
|
|
143
84
|
* Use emojis in section titles
|
|
85
|
+
*
|
|
144
86
|
* @default true
|
|
145
87
|
*/
|
|
146
88
|
emoji: boolean;
|
|
147
|
-
/**
|
|
148
|
-
* the section titles
|
|
149
|
-
*/
|
|
89
|
+
/** The section titles */
|
|
150
90
|
titles: {
|
|
151
|
-
/**
|
|
152
|
-
* the title of breaking changes section
|
|
153
|
-
*/
|
|
91
|
+
/** The title of breaking changes section */
|
|
154
92
|
breakingChanges: string;
|
|
155
93
|
};
|
|
156
|
-
/**
|
|
157
|
-
* the output file path of the changelog
|
|
158
|
-
*/
|
|
94
|
+
/** The output file path of the changelog */
|
|
159
95
|
output: string;
|
|
160
96
|
/**
|
|
161
97
|
* Whether to regenerate the changelog if it already exists
|
|
162
|
-
*
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* the changelog already exists the content of v0.0.1, but you want to regenerate it
|
|
163
101
|
*/
|
|
164
102
|
regenerate: boolean;
|
|
165
103
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
104
|
+
* Version from package.json, with prefix "v"
|
|
105
|
+
*
|
|
106
|
+
* If the options "to" is not specified, the version will be used
|
|
168
107
|
*/
|
|
169
108
|
newVersion: string;
|
|
170
|
-
/**
|
|
171
|
-
* Mark the release as prerelease
|
|
172
|
-
*/
|
|
109
|
+
/** Mark the release as prerelease */
|
|
173
110
|
prerelease?: boolean;
|
|
174
111
|
}
|
|
175
112
|
|
|
176
113
|
/**
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
* @param
|
|
114
|
+
* Get the changelog markdown by two git tags
|
|
115
|
+
*
|
|
116
|
+
* @param options The changelog options
|
|
117
|
+
* @param showTitle Whither show the title
|
|
180
118
|
*/
|
|
181
119
|
declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTitle?: boolean): Promise<{
|
|
182
120
|
markdown: string;
|
|
@@ -184,20 +122,23 @@ declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTi
|
|
|
184
122
|
options: ChangelogOption;
|
|
185
123
|
}>;
|
|
186
124
|
/**
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
* @param
|
|
125
|
+
* Get the changelog markdown by the total git tags
|
|
126
|
+
*
|
|
127
|
+
* @param options The changelog options
|
|
128
|
+
* @param showProgress Whither show the progress bar
|
|
190
129
|
*/
|
|
191
130
|
declare function getTotalChangelogMarkdown(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<string>;
|
|
192
131
|
/**
|
|
193
|
-
*
|
|
194
|
-
*
|
|
132
|
+
* Generate the changelog markdown by two git tags
|
|
133
|
+
*
|
|
134
|
+
* @param options The changelog options
|
|
195
135
|
*/
|
|
196
136
|
declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<void>;
|
|
197
137
|
/**
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* @param
|
|
138
|
+
* Generate the changelog markdown by the total git tags
|
|
139
|
+
*
|
|
140
|
+
* @param options The changelog options
|
|
141
|
+
* @param showProgress Whither show the progress bar
|
|
201
142
|
*/
|
|
202
143
|
declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
|
|
203
144
|
|
package/dist/index.d.ts
CHANGED
|
@@ -1,182 +1,120 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* the commit author
|
|
3
|
-
*/
|
|
1
|
+
/** The commit author */
|
|
4
2
|
interface GitCommitAuthor {
|
|
5
|
-
/**
|
|
6
|
-
* the author name
|
|
7
|
-
*/
|
|
3
|
+
/** The author name */
|
|
8
4
|
name: string;
|
|
9
|
-
/**
|
|
10
|
-
* the author email
|
|
11
|
-
*/
|
|
5
|
+
/** The author email */
|
|
12
6
|
email: string;
|
|
13
7
|
}
|
|
14
|
-
/**
|
|
15
|
-
* the raw git commit
|
|
16
|
-
*/
|
|
8
|
+
/** The raw git commit */
|
|
17
9
|
interface RawGitCommit {
|
|
18
|
-
/**
|
|
19
|
-
* the commit message
|
|
20
|
-
*/
|
|
10
|
+
/** The commit message */
|
|
21
11
|
message: string;
|
|
22
|
-
/**
|
|
23
|
-
* the commit body
|
|
24
|
-
*/
|
|
12
|
+
/** The commit body */
|
|
25
13
|
body: string;
|
|
26
|
-
/**
|
|
27
|
-
* the commit hash
|
|
28
|
-
*/
|
|
14
|
+
/** The commit hash */
|
|
29
15
|
shortHash: string;
|
|
30
|
-
/**
|
|
31
|
-
* the commit author
|
|
32
|
-
*/
|
|
16
|
+
/** The commit author */
|
|
33
17
|
author: GitCommitAuthor;
|
|
34
18
|
}
|
|
35
|
-
/**
|
|
36
|
-
* the reference of the commit
|
|
37
|
-
*/
|
|
19
|
+
/** The reference of the commit */
|
|
38
20
|
interface Reference {
|
|
39
|
-
/**
|
|
40
|
-
* the reference type
|
|
41
|
-
*/
|
|
21
|
+
/** The reference type */
|
|
42
22
|
type: 'hash' | 'issue' | 'pull-request';
|
|
43
|
-
/**
|
|
44
|
-
* the reference value
|
|
45
|
-
*/
|
|
23
|
+
/** The reference value */
|
|
46
24
|
value: string;
|
|
47
25
|
}
|
|
48
|
-
/**
|
|
49
|
-
* the resolved github author
|
|
50
|
-
*/
|
|
26
|
+
/** The resolved github author */
|
|
51
27
|
interface ResolvedAuthor extends GitCommitAuthor {
|
|
52
|
-
/**
|
|
53
|
-
* the git commit of the author
|
|
54
|
-
*/
|
|
28
|
+
/** The git commit of the author */
|
|
55
29
|
commits: string[];
|
|
56
|
-
/**
|
|
57
|
-
* the github logged username of the author
|
|
58
|
-
*/
|
|
30
|
+
/** The github logged username of the author */
|
|
59
31
|
login: string;
|
|
60
32
|
}
|
|
61
|
-
/**
|
|
62
|
-
* git commit config
|
|
63
|
-
*/
|
|
33
|
+
/** Git commit config */
|
|
64
34
|
interface GitCommit extends RawGitCommit {
|
|
65
|
-
/**
|
|
66
|
-
* the commit description
|
|
67
|
-
*/
|
|
35
|
+
/** The commit description */
|
|
68
36
|
description: string;
|
|
69
|
-
/**
|
|
70
|
-
* the commit scope type
|
|
71
|
-
*/
|
|
37
|
+
/** The commit scope type */
|
|
72
38
|
type: string;
|
|
73
|
-
/**
|
|
74
|
-
* the commit scope
|
|
75
|
-
*/
|
|
39
|
+
/** The commit scope */
|
|
76
40
|
scope: string;
|
|
77
|
-
/**
|
|
78
|
-
* the commit references
|
|
79
|
-
*/
|
|
41
|
+
/** The commit references */
|
|
80
42
|
references: Reference[];
|
|
81
|
-
/**
|
|
82
|
-
* the commit authors
|
|
83
|
-
*/
|
|
43
|
+
/** The commit authors */
|
|
84
44
|
authors: GitCommitAuthor[];
|
|
85
|
-
/**
|
|
86
|
-
* the resolved authors
|
|
87
|
-
*/
|
|
45
|
+
/** The resolved authors */
|
|
88
46
|
resolvedAuthors: ResolvedAuthor[];
|
|
89
|
-
/**
|
|
90
|
-
* the commit breaking changes
|
|
91
|
-
*/
|
|
47
|
+
/** The commit breaking changes */
|
|
92
48
|
isBreaking: boolean;
|
|
93
49
|
}
|
|
94
|
-
/**
|
|
95
|
-
* github config
|
|
96
|
-
*/
|
|
50
|
+
/** Github config */
|
|
97
51
|
interface GithubConfig {
|
|
98
52
|
/**
|
|
99
|
-
*
|
|
100
|
-
*
|
|
53
|
+
* The github repository name
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* soybeanjs / changelog;
|
|
101
57
|
*/
|
|
102
58
|
repo: string;
|
|
103
|
-
/**
|
|
104
|
-
* the github token
|
|
105
|
-
*/
|
|
59
|
+
/** The github token */
|
|
106
60
|
token: string;
|
|
107
61
|
}
|
|
108
62
|
interface ChangelogOption {
|
|
109
63
|
/**
|
|
110
|
-
*
|
|
64
|
+
* The directory of the project
|
|
65
|
+
*
|
|
111
66
|
* @default process.cwd()
|
|
112
67
|
*/
|
|
113
68
|
cwd: string;
|
|
114
|
-
/**
|
|
115
|
-
* the commit scope types
|
|
116
|
-
*/
|
|
69
|
+
/** The commit scope types */
|
|
117
70
|
types: Record<string, string>;
|
|
118
|
-
/**
|
|
119
|
-
* github config
|
|
120
|
-
*/
|
|
71
|
+
/** Github config */
|
|
121
72
|
github: GithubConfig;
|
|
122
|
-
/**
|
|
123
|
-
* the commit hash or tag
|
|
124
|
-
*/
|
|
73
|
+
/** The commit hash or tag */
|
|
125
74
|
from: string;
|
|
126
|
-
/**
|
|
127
|
-
* the commit hash or tag
|
|
128
|
-
*/
|
|
75
|
+
/** The commit hash or tag */
|
|
129
76
|
to: string;
|
|
130
|
-
/**
|
|
131
|
-
* the whole commit tags
|
|
132
|
-
*/
|
|
77
|
+
/** The whole commit tags */
|
|
133
78
|
tags: string[];
|
|
134
|
-
/**
|
|
135
|
-
* the commit tag and date map
|
|
136
|
-
*/
|
|
79
|
+
/** The commit tag and date map */
|
|
137
80
|
tagDateMap: Map<string, string>;
|
|
138
|
-
/**
|
|
139
|
-
* Whether to capitalize the first letter of the commit type
|
|
140
|
-
*/
|
|
81
|
+
/** Whether to capitalize the first letter of the commit type */
|
|
141
82
|
capitalize: boolean;
|
|
142
83
|
/**
|
|
143
84
|
* Use emojis in section titles
|
|
85
|
+
*
|
|
144
86
|
* @default true
|
|
145
87
|
*/
|
|
146
88
|
emoji: boolean;
|
|
147
|
-
/**
|
|
148
|
-
* the section titles
|
|
149
|
-
*/
|
|
89
|
+
/** The section titles */
|
|
150
90
|
titles: {
|
|
151
|
-
/**
|
|
152
|
-
* the title of breaking changes section
|
|
153
|
-
*/
|
|
91
|
+
/** The title of breaking changes section */
|
|
154
92
|
breakingChanges: string;
|
|
155
93
|
};
|
|
156
|
-
/**
|
|
157
|
-
* the output file path of the changelog
|
|
158
|
-
*/
|
|
94
|
+
/** The output file path of the changelog */
|
|
159
95
|
output: string;
|
|
160
96
|
/**
|
|
161
97
|
* Whether to regenerate the changelog if it already exists
|
|
162
|
-
*
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* the changelog already exists the content of v0.0.1, but you want to regenerate it
|
|
163
101
|
*/
|
|
164
102
|
regenerate: boolean;
|
|
165
103
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
104
|
+
* Version from package.json, with prefix "v"
|
|
105
|
+
*
|
|
106
|
+
* If the options "to" is not specified, the version will be used
|
|
168
107
|
*/
|
|
169
108
|
newVersion: string;
|
|
170
|
-
/**
|
|
171
|
-
* Mark the release as prerelease
|
|
172
|
-
*/
|
|
109
|
+
/** Mark the release as prerelease */
|
|
173
110
|
prerelease?: boolean;
|
|
174
111
|
}
|
|
175
112
|
|
|
176
113
|
/**
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
* @param
|
|
114
|
+
* Get the changelog markdown by two git tags
|
|
115
|
+
*
|
|
116
|
+
* @param options The changelog options
|
|
117
|
+
* @param showTitle Whither show the title
|
|
180
118
|
*/
|
|
181
119
|
declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTitle?: boolean): Promise<{
|
|
182
120
|
markdown: string;
|
|
@@ -184,20 +122,23 @@ declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTi
|
|
|
184
122
|
options: ChangelogOption;
|
|
185
123
|
}>;
|
|
186
124
|
/**
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
* @param
|
|
125
|
+
* Get the changelog markdown by the total git tags
|
|
126
|
+
*
|
|
127
|
+
* @param options The changelog options
|
|
128
|
+
* @param showProgress Whither show the progress bar
|
|
190
129
|
*/
|
|
191
130
|
declare function getTotalChangelogMarkdown(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<string>;
|
|
192
131
|
/**
|
|
193
|
-
*
|
|
194
|
-
*
|
|
132
|
+
* Generate the changelog markdown by two git tags
|
|
133
|
+
*
|
|
134
|
+
* @param options The changelog options
|
|
195
135
|
*/
|
|
196
136
|
declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<void>;
|
|
197
137
|
/**
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* @param
|
|
138
|
+
* Generate the changelog markdown by the total git tags
|
|
139
|
+
*
|
|
140
|
+
* @param options The changelog options
|
|
141
|
+
* @param showProgress Whither show the progress bar
|
|
201
142
|
*/
|
|
202
143
|
declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
|
|
203
144
|
|
package/dist/index.mjs
CHANGED
|
@@ -1,19 +1,26 @@
|
|
|
1
|
-
import{SingleBar as
|
|
2
|
-
`)
|
|
3
|
-
|
|
4
|
-
`).
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import{SingleBar as W,Presets as J}from"cli-progress";import A from"node:process";import{readFile as _,writeFile as E}from"node:fs/promises";import{ofetch as b}from"ofetch";import D from"dayjs";import{existsSync as K}from"node:fs";import{convert as Q}from"convert-gitmoji";const g={silent:Number.NEGATIVE_INFINITY,fatal:0,error:0,warn:1,log:2,info:3,success:3,fail:3,ready:3,start:3,box:3,debug:4,trace:5,verbose:Number.POSITIVE_INFINITY},T={silent:{level:-1},fatal:{level:g.fatal},error:{level:g.error},warn:{level:g.warn},log:{level:g.log},info:{level:g.info},success:{level:g.success},fail:{level:g.fail},ready:{level:g.info},start:{level:g.info},box:{level:g.info},debug:{level:g.debug},trace:{level:g.trace},verbose:{level:g.verbose}};function v(o){return o!==null&&typeof o=="object"}function $(o,t,e=".",s){if(!v(t))return $(o,{},e,s);const r=Object.assign({},t);for(const n in o){if(n==="__proto__"||n==="constructor")continue;const i=o[n];i!=null&&(s&&s(r,n,i,e)||(Array.isArray(i)&&Array.isArray(r[n])?r[n]=[...i,...r[n]]:v(i)&&v(r[n])?r[n]=$(i,r[n],(e?`${e}.`:"")+n.toString(),s):r[n]=i))}return r}function X(o){return(...t)=>t.reduce((e,s)=>$(e,s,"",o),{})}const Z=X();function tt(o){return Object.prototype.toString.call(o)==="[object Object]"}function et(o){return!(!tt(o)||!o.message&&!o.args||o.stack)}let F=!1;const M=[];class f{constructor(t={}){const e=t.types||T;this.options=Z({...t,defaults:{...t.defaults},level:C(t.level,e),reporters:[...t.reporters||[]]},{types:T,throttle:1e3,throttleMin:5,formatOptions:{date:!0,colors:!1,compact:!0}});for(const s in e){const r={type:s,...this.options.defaults,...e[s]};this[s]=this._wrapLogFn(r),this[s].raw=this._wrapLogFn(r,!0)}this.options.mockFn&&this.mockTypes(),this._lastLog={}}get level(){return this.options.level}set level(t){this.options.level=C(t,this.options.types,this.options.level)}prompt(t,e){if(!this.options.prompt)throw new Error("prompt is not supported!");return this.options.prompt(t,e)}create(t){const e=new f({...this.options,...t});return this._mockFn&&e.mockTypes(this._mockFn),e}withDefaults(t){return this.create({...this.options,defaults:{...this.options.defaults,...t}})}withTag(t){return this.withDefaults({tag:this.options.defaults.tag?this.options.defaults.tag+":"+t:t})}addReporter(t){return this.options.reporters.push(t),this}removeReporter(t){if(t){const e=this.options.reporters.indexOf(t);if(e>=0)return this.options.reporters.splice(e,1)}else this.options.reporters.splice(0);return this}setReporters(t){return this.options.reporters=Array.isArray(t)?t:[t],this}wrapAll(){this.wrapConsole(),this.wrapStd()}restoreAll(){this.restoreConsole(),this.restoreStd()}wrapConsole(){for(const t in this.options.types)console["__"+t]||(console["__"+t]=console[t]),console[t]=this[t].raw}restoreConsole(){for(const t in this.options.types)console["__"+t]&&(console[t]=console["__"+t],delete console["__"+t])}wrapStd(){this._wrapStream(this.options.stdout,"log"),this._wrapStream(this.options.stderr,"log")}_wrapStream(t,e){t&&(t.__write||(t.__write=t.write),t.write=s=>{this[e].raw(String(s).trim())})}restoreStd(){this._restoreStream(this.options.stdout),this._restoreStream(this.options.stderr)}_restoreStream(t){t&&t.__write&&(t.write=t.__write,delete t.__write)}pauseLogs(){F=!0}resumeLogs(){F=!1;const t=M.splice(0);for(const e of t)e[0]._logFn(e[1],e[2])}mockTypes(t){const e=t||this.options.mockFn;if(this._mockFn=e,typeof e=="function")for(const s in this.options.types)this[s]=e(s,this.options.types[s])||this[s],this[s].raw=this[s]}_wrapLogFn(t,e){return(...s)=>{if(F){M.push([this,t,s,e]);return}return this._logFn(t,s,e)}}_logFn(t,e,s){if((t.level||0)>this.level)return!1;const r={date:new Date,args:[],...t,level:C(t.level,this.options.types)};!s&&e.length===1&&et(e[0])?Object.assign(r,e[0]):r.args=[...e],r.message&&(r.args.unshift(r.message),delete r.message),r.additional&&(Array.isArray(r.additional)||(r.additional=r.additional.split(`
|
|
2
|
+
`)),r.args.push(`
|
|
3
|
+
`+r.additional.join(`
|
|
4
|
+
`)),delete r.additional),r.type=typeof r.type=="string"?r.type.toLowerCase():"log",r.tag=typeof r.tag=="string"?r.tag:"";const n=(a=!1)=>{const c=(this._lastLog.count||0)-this.options.throttleMin;if(this._lastLog.object&&c>0){const l=[...this._lastLog.object.args];c>1&&l.push(`(repeated ${c} times)`),this._log({...this._lastLog.object,args:l}),this._lastLog.count=1}a&&(this._lastLog.object=r,this._log(r))};clearTimeout(this._lastLog.timeout);const i=this._lastLog.time&&r.date?r.date.getTime()-this._lastLog.time.getTime():0;if(this._lastLog.time=r.date,i<this.options.throttle)try{const a=JSON.stringify([r.type,r.tag,r.args]),c=this._lastLog.serialized===a;if(this._lastLog.serialized=a,c&&(this._lastLog.count=(this._lastLog.count||0)+1,this._lastLog.count>this.options.throttleMin)){this._lastLog.timeout=setTimeout(n,this.options.throttle);return}}catch{}n(!0)}_log(t){for(const e of this.options.reporters)e.log(t,{options:this.options})}}function C(o,t={},e=3){return o===void 0?e:typeof o=="number"?o:t[o]&&t[o].level!==void 0?t[o].level:e}f.prototype.add=f.prototype.addReporter,f.prototype.remove=f.prototype.removeReporter,f.prototype.clear=f.prototype.removeReporter,f.prototype.withScope=f.prototype.withTag,f.prototype.mock=f.prototype.mockTypes,f.prototype.pause=f.prototype.pauseLogs,f.prototype.resume=f.prototype.resumeLogs;function ot(o={}){return new f(o)}class st{constructor(t){this.options={...t},this.defaultColor="#7f8c8d",this.levelColorMap={0:"#c0392b",1:"#f39c12",3:"#00BCD4"},this.typeColorMap={success:"#2ecc71"}}_getLogFn(t){return t<1?console.__error||console.error:t===1?console.__warn||console.warn:console.__log||console.log}log(t){const e=this._getLogFn(t.level),s=t.type==="log"?"":t.type,r=t.tag||"",i=`
|
|
5
|
+
background: ${this.typeColorMap[t.type]||this.levelColorMap[t.level]||this.defaultColor};
|
|
6
|
+
border-radius: 0.5em;
|
|
7
|
+
color: white;
|
|
8
|
+
font-weight: bold;
|
|
9
|
+
padding: 2px 0.5em;
|
|
10
|
+
`,a=`%c${[r,s].filter(Boolean).join(":")}`;typeof t.args[0]=="string"?e(`${a}%c ${t.args[0]}`,i,"",...t.args.slice(1)):e(a,i,...t.args)}}function rt(o={}){return ot({reporters:o.reporters||[new st({})],prompt(e,s={}){return s.type==="confirm"?Promise.resolve(confirm(e)):Promise.resolve(prompt(e))},...o})}const L=rt();async function w(o,t,e){const{execa:s}=await import("execa");return(await s(o,t,e))?.stdout?.trim()||""}function nt(o){return o!=null}function it(o,...t){const e=Array.from({length:t.length+1}).fill(null).map(()=>[]);return o.forEach((s,r,n)=>{let i=0;for(const a of t){if(a(s,r,n)){e[i].push(s);return}i+=1}e[i].push(s)}),e}function S(o,t,e={}){for(const s of o){const r=s[t];e[r]||(e[r]=[]),e[r].push(s)}return e}function at(o){return o.charAt(0).toUpperCase()+o.slice(1)}function j(o,t=", ",e=" and "){return!o||o.length===0?"":o.length===1?o[0]:o.length===2?o.join(e):`${o.slice(0,-1).join(t)}${e}${o.slice(-1)}`}const x=/v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/,ct=/## \[v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?]/g,lt=/release\sv\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/;async function I(){return(await w("git",["--no-pager","tag","-l","--sort=creatordate"])).split(`
|
|
11
|
+
`)}async function ut(){const o=await w("git",["--no-pager","log","--tags","--simplify-by-decoration","--pretty=format:%ci %d"]),t="tag: ",e=new Map;return o.split(`
|
|
12
|
+
`).filter(s=>s.includes(t)).forEach(s=>{const[r,n]=s.split(t),i=D(r).format("YYYY-MM-DD"),a=n.match(x)?.[0];a&&i&&e.set(a.trim(),i)}),e}function pt(o){const t=[];return o.forEach((e,s)=>{s<o.length-1&&t.push({from:e,to:o[s+1]})}),t}async function N(o=0){const t=await I();return t[t.length+o-1]}async function ht(){return await w("git",["rev-parse","--abbrev-ref","HEAD"])}async function ft(){const o=await w("git",["tag","--points-at","HEAD"]),t=ht();return o||t}async function gt(){const o=await w("git",["config","--get","remote.origin.url"]),t=o.match(/github\.com[/:]([\w\d._-]+?)\/([\w\d._-]+?)(\.git)?$/i);if(!t)throw new Error(`Can not parse GitHub repo from url ${o}`);return`${t[1]}/${t[2]}`}function mt(o){return!/^[^.]*[\d.]+$/.test(o)}function dt(){return w("git",["rev-list","--max-parents=0","HEAD"])}async function wt(o,t="HEAD"){return(await w("git",["--no-pager","log",`${o?`${o}...`:""}${t}`,'--pretty="----%n%s|%h|%an|%ae%n%b"',"--name-status"])).split(`----
|
|
13
|
+
`).splice(1).map(e=>{const[s,...r]=e.split(`
|
|
14
|
+
`),[n,i,a,c]=s.split("|");return{message:n,shortHash:i,author:{name:a,email:c},body:r.join(`
|
|
15
|
+
`)}})}function yt(o){const t=/(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i,e=/co-authored-by:\s*(?<name>.+)(<(?<email>.+)>)/gim,s=/\([a-z]*(#\d+)\s*\)/gm,r=/(#\d+)/gm,n=o.message.match(t);if(!n?.groups)return null;const i=n.groups.type,a=n.groups.scope||"",c=!!n.groups.breaking;let l=n.groups.description;const u=[];for(const h of l.matchAll(s))u.push({type:"pull-request",value:h[1]});for(const h of l.matchAll(r))u.some(d=>d.value===h[1])||u.push({type:"issue",value:h[1]});u.push({value:o.shortHash,type:"hash"}),l=l.replace(s,"").trim();const m=[o.author],p=o.body.matchAll(e);for(const h of p){const{name:d="",email:q=""}=h.groups||{},U={name:d.trim(),email:q.trim()};m.push(U)}return{...o,authors:m,resolvedAuthors:[],description:l,type:i,scope:a,references:u,isBreaking:c}}async function R(o,t="HEAD"){return(await wt(o,t)).map(e=>yt(e)).filter(nt)}function G(o){return{accept:"application/vnd.github.v3+json",authorization:`token ${o}`}}async function _t(o,t,e){let s="";try{s=(await b(`https://ungh.cc/users/find/${e}`))?.user?.username||""}catch(i){L.log("e: ",i)}if(s)return s;const{repo:r,token:n}=o;if(!n)return s;if(t.length)try{s=(await b(`https://api.github.com/repos/${r}/commits/${t[0]}`,{headers:G(n)}))?.author?.login||""}catch(i){L.log("e: ",i)}if(s)return s;try{s=(await b(`https://api.github.com/search/users?q=${encodeURIComponent(e)}`,{headers:G(n)})).items[0].login}catch(i){L.log("e: ",i)}return s}async function H(o,t,e){const s=[],r=new Map;for await(const n of o){const i=[];for await(const[c,l]of n.authors.entries()){const{email:u,name:m}=l;if(u&&m){const p=[];c===0&&p.push(n.shortHash);const h={name:m,email:u,commits:p,login:""};if(e?.has(u)){const d=e?.get(u)||"";h.login=d}else{const d=await _t(t,p,u);h.login=d,e?.set(u,d)}i.push(h),r.has(u)||r.set(u,h)}}const a={...n,resolvedAuthors:i};s.push(a)}return{commits:s,contributors:Array.from(r.values())}}function bt(){return{cwd:A.cwd(),types:{feat:"\u{1F680} Features",fix:"\u{1F41E} Bug Fixes",perf:"\u{1F525} Performance",refactor:"\u{1F485} Refactors",docs:"\u{1F4D6} Documentation",build:"\u{1F4E6} Build",types:"\u{1F30A} Types",chore:"\u{1F3E1} Chore",examples:"\u{1F3C0} Examples",test:"\u2705 Tests",style:"\u{1F3A8} Styles",ci:"\u{1F916} CI"},github:{repo:"",token:A.env.GITHUB_TOKEN||""},from:"",to:"",tags:[],tagDateMap:new Map,capitalize:!1,emoji:!0,titles:{breakingChanges:"\u{1F6A8} Breaking Changes"},output:"CHANGELOG.md",regenerate:!1,newVersion:""}}async function vt(o){let t="";try{const e=await _(`${o}/package.json`,"utf-8");t=JSON.parse(e)?.version||""}catch{}return{newVersion:t}}async function y(o){var t;const e=bt();Object.assign(e,o);const{newVersion:s}=await vt(e.cwd);if((t=e.github).repo||(t.repo=await gt()),e.newVersion||(e.newVersion=`v${s}`),e.from||(e.from=await N()),e.to||(e.to=await ft()),e.to===e.from){const r=await N(-1),n=await dt();e.from=r||n}return e.tags=await I(),e.tagDateMap=await ut(),e.prerelease||(e.prerelease=mt(e.to)),e}function O(o,t,e){const s=o.filter(n=>e==="issues"?n.type==="issue"||n.type==="pull-request":n.type==="hash").map(n=>t?n.type==="pull-request"||n.type==="issue"?`https://github.com/${t}/issues/${n.value.slice(1)}`:`[<samp>(${n.value.slice(0,5)})</samp>](https://github.com/${t}/commit/${n.value})`:n.value),r=j(s).trim();return e==="issues"?r&&`in ${r}`:r}function $t(o,t){const e=O(o.references,t.github.repo,"issues"),s=O(o.references,t.github.repo,"hash");let r=j([...new Set(o.resolvedAuthors.map(i=>i.login?`@${i.login}`:`**${i.name}**`))]).trim();r&&(r=`by ${r}`);let n=[r,e,s].filter(i=>i?.trim()).join(" ");return n&&(n=` - ${n}`),[t.capitalize?at(o.description):o.description,n].filter(i=>i?.trim()).join(" ")}function Ft(o,t){const e=/([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;let s=o.trim();return t.emoji||(s=o.replace(e,"").trim()),`### ${s}`}function B(o,t,e){if(!o.length)return[];const s=["",Ft(t,e),""],r=S(o,"scope");let n=!0;return Object.entries(r).some(([i,a])=>i&&a.length>1)||(n=!1),Object.keys(r).sort().forEach(i=>{let a="",c="";const l=`**${i}**`;i&&n?(s.push(`- ${l}:`),a=" "):i&&(c=`${l}: `),s.push(...r[i].reverse().map(u=>`${a}- ${c}${$t(u,e)}`))}),s}function V(o){return`https://github.com/${o}`}function Ct(o){return`${V(o)}.png?size=48`}function Lt(o){let t="",e="";const s=new Map;return o.forEach(r=>{s.set(r.email,r)}),Array.from(s.values()).forEach((r,n)=>{const{name:i,email:a,login:c}=r;if(c){const l=V(c),u=Ct(c);t+=`[](${l}) `}else{let l=`[${i}](mailto:${a})`;n<o.length-1&&(l+=", "),e+=l}}),`${t}
|
|
16
|
+
${e}`}function z(o){const{options:t,showTitle:e,contributors:s}=o,r=o.commits.filter(p=>p.description.match(lt)===null),n=[],i=!x.test(t.to),a=i?t.newVersion:t.to,c=`https://github.com/${t.github.repo}/compare/${t.from}...${a}`;if(e){const p=i?D().format("YY-MM-DD"):t.tagDateMap.get(t.to);let h=`## [${a}](${c})`;p&&(h+=` (${p})`),n.push(h)}const[l,u]=it(r,p=>p.isBreaking),m=S(u,"type");n.push(...B(l,t.titles.breakingChanges,t));for(const p of Object.keys(t.types)){const h=m[p]||[];n.push(...B(h,t.types[p],t))}if(n.length||n.push("*No significant changes*"),e||n.push("",`##### [View changes on GitHub](${c})`),e){n.push("","### \u2764\uFE0F Contributors","");const p=Lt(s);n.push(p)}return Q(n.join(`
|
|
17
|
+
`).trim(),!0)}async function kt(o,t){let e=!1;const s=await _(t,"utf8");if(s){const r=s.match(ct);if(r?.length){const n=`## [${o}]`;e=r.includes(n)}}return e}async function Y(o,t,e=!1){let s="";const r="# Changelog";K(t)||await E(t,r,"utf8"),e||(s=await _(t,"utf8")),s.startsWith(r)||(s=`${r}
|
|
9
18
|
|
|
10
|
-
${
|
|
19
|
+
${s}`);const n=s.match(/^###?\s+.*$/m);n?s+=`${s.slice(0,n.index)+o}
|
|
11
20
|
|
|
12
|
-
|
|
21
|
+
${s.slice(n.index)}`:s+=`
|
|
22
|
+
${o}
|
|
13
23
|
|
|
14
|
-
|
|
15
|
-
${t}
|
|
24
|
+
`,await E(t,s)}async function k(o,t=!0){const e=await y(o),s=await R(e.from,e.to),{commits:r,contributors:n}=await H(s,e.github);return{markdown:z({commits:r,options:e,showTitle:t,contributors:n}),commits:r,options:e}}async function P(o,t=!0){const e=await y(o);let s=null;t&&(s=new W({format:"generate total changelog: [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}"},J.shades_classic));const r=pt(e.tags);if(r.length===0){const{markdown:a}=await k(e);return a}s?.start(r.length,0);let n="";const i=new Map;for await(const[a,c]of r.entries()){const{from:l,to:u}=c,m=await R(l,u),{commits:p,contributors:h}=await H(m,e.github,i);n=`${z({commits:p,options:{...e,from:l,to:u},showTitle:!0,contributors:h})}
|
|
16
25
|
|
|
17
|
-
`,
|
|
18
|
-
|
|
19
|
-
${s}`,o?.update(i+1)}return o?.stop(),s}async function pt(t){const n=await w(t),e=await ut(n.to,n.output);if(!n.regenerate&&e)return;const{markdown:o}=await b(n);await x(o,n.output,n.regenerate)}async function lt(t,n=!0){const e=await w(t),o=await O(e,n);await x(o,e.output,!0)}export{pt as generateChangelog,lt as generateTotalChangelog,b as getChangelogMarkdown,O as getTotalChangelogMarkdown};
|
|
26
|
+
${n}`,s?.update(a+1)}return s?.stop(),n}async function At(o){const t=await y(o),e=await kt(t.to,t.output);if(!t.regenerate&&e)return;const{markdown:s}=await k(t);await Y(s,t.output,t.regenerate)}async function Et(o,t=!0){const e=await y(o),s=await P(e,t);await Y(s,e.output,!0)}export{At as generateChangelog,Et as generateTotalChangelog,k as getChangelogMarkdown,P as getTotalChangelogMarkdown};
|
package/package.json
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@soybeanjs/changelog",
|
|
3
|
-
"
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "0.3.5",
|
|
5
|
+
"packageManager": "pnpm@8.12.0",
|
|
4
6
|
"description": "generate changelog form git tags and commits for github",
|
|
5
7
|
"author": {
|
|
6
8
|
"name": "Soybean",
|
|
7
|
-
"email": "
|
|
8
|
-
"url": "https://github.com/
|
|
9
|
+
"email": "soybeanjs@outlook.com",
|
|
10
|
+
"url": "https://github.com/soybeanjs"
|
|
9
11
|
},
|
|
10
12
|
"license": "MIT",
|
|
11
13
|
"homepage": "https://github.com/soybeanjs/changelog",
|
|
@@ -18,11 +20,12 @@
|
|
|
18
20
|
"publishConfig": {
|
|
19
21
|
"registry": "https://registry.npmjs.org/"
|
|
20
22
|
},
|
|
23
|
+
"sideEffects": false,
|
|
21
24
|
"exports": {
|
|
22
25
|
".": {
|
|
26
|
+
"types": "./dist/index.d.ts",
|
|
23
27
|
"import": "./dist/index.mjs",
|
|
24
|
-
"require": "./dist/index.cjs"
|
|
25
|
-
"types": "./dist/index.d.ts"
|
|
28
|
+
"require": "./dist/index.cjs"
|
|
26
29
|
}
|
|
27
30
|
},
|
|
28
31
|
"main": "./dist/index.cjs",
|
|
@@ -32,38 +35,41 @@
|
|
|
32
35
|
"dist"
|
|
33
36
|
],
|
|
34
37
|
"dependencies": {
|
|
38
|
+
"@soybeanjs/eslint-config": "^1.0.9",
|
|
35
39
|
"cli-progress": "3.12.0",
|
|
36
40
|
"convert-gitmoji": "0.1.3",
|
|
37
|
-
"dayjs": "1.11.
|
|
41
|
+
"dayjs": "1.11.10",
|
|
38
42
|
"execa": "8.0.1",
|
|
39
|
-
"ofetch": "1.
|
|
43
|
+
"ofetch": "1.3.3"
|
|
40
44
|
},
|
|
41
45
|
"devDependencies": {
|
|
42
|
-
"@soybeanjs/cli": "0.
|
|
43
|
-
"@types/cli-progress": "3.11.
|
|
44
|
-
"@types/node": "20.
|
|
45
|
-
"eslint": "8.
|
|
46
|
-
"
|
|
46
|
+
"@soybeanjs/cli": "0.8.8",
|
|
47
|
+
"@types/cli-progress": "3.11.5",
|
|
48
|
+
"@types/node": "20.10.4",
|
|
49
|
+
"eslint": "8.55.0",
|
|
50
|
+
"lint-staged": "15.2.0",
|
|
47
51
|
"simple-git-hooks": "2.9.0",
|
|
48
|
-
"tsx": "
|
|
49
|
-
"typescript": "5.
|
|
52
|
+
"tsx": "4.6.2",
|
|
53
|
+
"typescript": "5.3.3",
|
|
50
54
|
"unbuild": "2.0.0"
|
|
51
55
|
},
|
|
52
56
|
"simple-git-hooks": {
|
|
53
57
|
"commit-msg": "pnpm soy git-commit-verify",
|
|
54
|
-
"pre-commit": "pnpm typecheck && pnpm
|
|
58
|
+
"pre-commit": "pnpm typecheck && pnpm lint-staged"
|
|
59
|
+
},
|
|
60
|
+
"lint-staged": {
|
|
61
|
+
"*": "eslint --fix"
|
|
55
62
|
},
|
|
56
63
|
"scripts": {
|
|
57
|
-
"build": "
|
|
64
|
+
"build": "unbuild && pnpm build-pkg",
|
|
58
65
|
"build-pkg": "pnpm -r --filter='./packages/*' run build",
|
|
59
|
-
"stub": "pnpm unbuild --stub",
|
|
60
|
-
"lint": "eslint . --fix",
|
|
61
|
-
"format": "soy prettier-write",
|
|
62
|
-
"commit": "soy git-commit",
|
|
63
66
|
"cleanup": "soy cleanup",
|
|
64
|
-
"
|
|
67
|
+
"commit": "soy git-commit",
|
|
68
|
+
"lint": "eslint . --fix",
|
|
65
69
|
"publish-pkg": "pnpm -r publish --access public",
|
|
70
|
+
"release": "soy release",
|
|
71
|
+
"stub": "pnpm unbuild --stub",
|
|
66
72
|
"typecheck": "tsc --noEmit --skipLibCheck",
|
|
67
|
-
"
|
|
73
|
+
"update-pkg": "soy ncu"
|
|
68
74
|
}
|
|
69
75
|
}
|