@turbo/codemod 1.7.1-canary.4 → 1.7.1-canary.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/README.md +3 -2
- package/dist/cli.js +4 -4
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -28,12 +28,13 @@ Options:
|
|
|
28
28
|
-h, --help display help for command
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
### `transform`
|
|
31
|
+
### `transform` (default)
|
|
32
32
|
|
|
33
|
-
Runs a single codemod on your codebase.
|
|
33
|
+
Runs a single codemod on your codebase. This is the default command, and can be omitted.
|
|
34
34
|
|
|
35
35
|
```
|
|
36
36
|
Usage: @turbo/codemod transform [options] [transform] [path]
|
|
37
|
+
@turbo/codemod [options] [transform] [path]
|
|
37
38
|
|
|
38
39
|
Apply a single code transformation to a project
|
|
39
40
|
|
package/dist/cli.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
"use strict";var
|
|
2
|
+
"use strict";var Te=Object.create;var te=Object.defineProperty;var $e=Object.getOwnPropertyDescriptor;var Me=Object.getOwnPropertyNames;var Ce=Object.getPrototypeOf,je=Object.prototype.hasOwnProperty;var Ee=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of Me(e))!je.call(r,o)&&o!==t&&te(r,o,{get:()=>e[o],enumerable:!(n=$e(e,o))||n.enumerable});return r};var i=(r,e,t)=>(t=r!=null?Te(Ce(r)):{},Ee(e||!r||!r.__esModule?te(t,"default",{value:r,enumerable:!0}):t,r));var ee=i(require("chalk")),Pe=require("commander");var f=i(require("chalk")),x=i(require("os")),ke=i(require("inquirer")),we=require("child_process");var ie=i(require("path")),ae=require("fs-extra");var oe=i(require("find-up")),ne=i(require("path")),v={};function b({directory:r}){let e=r||process.cwd();if(v[e])return v[e];let t=oe.default.sync(["yarn.lock","pnpm-lock.yaml","package-lock.json"],{cwd:e});if(!!t){switch(ne.default.basename(t)){case"yarn.lock":v[e]="yarn";break;case"pnpm-lock.yaml":v[e]="pnpm";break;case"package-lock.json":v[e]="npm";break}return v[e]}}var se=require("child_process");function g(r,e,t){try{return(0,se.execSync)(r,e).toString("utf8").trim()}catch{return t||void 0}}function De(r,e){let{from:t}=e;if(t)return t;let n=g("turbo --version",{cwd:r});if(n)return n;let o=b({directory:r});if(o){if(o==="yarn")return g("yarn turbo --version",{cwd:r});if(o==="pnpm")return g("pnpm turbo --version",{cwd:r});{let s=ie.default.join(r,"node_modules",".bin","turbo");if((0,ae.existsSync)(s))return g(`${s} --version`,{cwd:r})}}}var ce=De;var le=i(require("axios")),Re="https://registry.npmjs.org";async function Ae({packageName:r}){try{return(await le.default.get(`${Re}/${r}`)).data}catch{throw new Error(`Unable to fetch the latest version of ${r}`)}}async function B({to:r}){let e=await Ae({packageName:"turbo"}),t=e["dist-tags"];if(r){if(e[r])return r;throw new Error(`turbo@${r} does not exist`)}return t.latest}var A=require("semver");var R=i(require("path")),fe=i(require("fs-extra")),me=process.env.NODE_ENV==="test"?R.default.join(__dirname,"../transforms"):R.default.join(__dirname,"./transforms");function P(){return fe.default.readdirSync(me).map(e=>{let t=R.default.join(me,e);try{return require(t).default}catch{return}}).filter(Boolean)}function Oe({fromVersion:r,toVersion:e}){return P().filter(n=>(0,A.gt)(n.introducedIn,r)&&(0,A.lte)(n.introducedIn,e))}var de=Oe;var _=i(require("chalk")),pe=i(require("is-git-clean"));function T({directory:r,force:e}){let t=!1,n="Unable to determine if git directory is clean";try{t=pe.default.sync(r||process.cwd()),n="Git directory is not clean"}catch(o){o&&o.stderr&&o.stderr.indexOf("not a git repository")>=0&&(t=!0)}t||(e?console.log(`${_.default.yellow("WARNING")}: ${n}. Forcibly continuing...`):(console.log("Thank you for using @turbo/codemod!"),console.log(_.default.yellow(`
|
|
3
3
|
But before we continue, please stash or commit your git changes.`)),console.log(`
|
|
4
|
-
You may use the --force flag to override this safety check.`),process.exit(1)))}var
|
|
5
|
-
`)),process.exit(0);
|
|
6
|
-
`)),process.exit(1);let y=
|
|
4
|
+
You may use the --force flag to override this safety check.`),process.exit(1)))}var J=i(require("path")),ue=i(require("fs"));function k({directory:r}){let e=J.default.isAbsolute(r)?r:J.default.join(process.cwd(),r);return{exists:ue.default.existsSync(e),absolute:e}}var U=i(require("os")),Y=i(require("path")),F=i(require("fs-extra")),ge=require("semver");var O=require("child_process");function K(r,e){switch(r){case"yarn":return(0,O.execSync)("yarn --version",{cwd:e}).toString().trim();case"pnpm":return(0,O.execSync)("pnpm --version",{cwd:e}).toString().trim();case"npm":return(0,O.execSync)("npm --version",{cwd:e}).toString().trim()}}function Ue(){return{yarn:g("yarn global bin",{cwd:U.default.homedir()}),npm:g("npm bin --global",{cwd:U.default.homedir()}),pnpm:g("pnpm bin --global",{cwd:U.default.homedir()})}}function Fe(r,e="latest"){switch(r){case"yarn":return`yarn global add turbo@${e}`;case"npm":return`npm install turbo@${e} --global`;case"pnpm":return`pnpm install turbo@${e} --global`}}function Se({packageManager:r,packageManagerVersion:e,installType:t,isUsingWorkspaces:n,to:o="latest"}){let s=a=>a.filter(Boolean).join(" ");switch(r){case"yarn":return(0,ge.gte)(e,"2.0.0")?s(["yarn","add",`turbo@${o}`,t==="devDependencies"&&"--dev"]):s(["yarn","add",`turbo@${o}`,t==="devDependencies"&&"--dev",n&&"-W"]);case"npm":return s(["npm","install",`turbo@${o}`,t==="devDependencies"&&"--save-dev"]);case"pnpm":return s(["pnpm","install",`turbo@${o}`,t==="devDependencies"&&"--save-dev",n&&"-w"])}}function Ie({directory:r}){let e=Y.default.join(r,"package.json"),t=Y.default.join(r,"pnpm-workspace.yaml"),n=F.default.existsSync(t);if(!F.default.existsSync(e))return console.error(`Unable to find package.json at ${e}`),{installType:void 0,isUsingWorkspaces:void 0};let o=F.default.readJsonSync(e),s=o.devDependencies&&"turbo"in o.devDependencies,a=o.dependencies&&"turbo"in o.dependencies,m="workspaces"in o||n;return a||s?{installType:a?"dependencies":"devDependencies",isUsingWorkspaces:m}:{installType:void 0,isUsingWorkspaces:m}}function H({directory:r,to:e}){let t=g("turbo bin",{cwd:r,stdio:"pipe"}),n=Ue(),o=Object.keys(n).find(s=>{let a=n[s];return a&&t?t.includes(a):!1});if(t&&o)return Fe(o,e);{let s=b({directory:r}),{installType:a,isUsingWorkspaces:m}=Ie({directory:r});if(s&&a){let d=K(s,r);return Se({packageManager:s,packageManagerVersion:d,installType:a,isUsingWorkspaces:m,to:e})}}}var j=i(require("chalk"));var S=i(require("chalk")),I=require("diff"),$=i(require("fs-extra")),he=i(require("os")),z=i(require("path")),M=class{constructor(e){this.changes=[];if(this.filePath=e.filePath,this.rootPath=e.rootPath,this.after=e.after,this.error=e.error,e.before===void 0)try{z.default.extname(e.filePath)===".json"?this.before=$.default.readJsonSync(e.filePath):this.before=$.default.readFileSync(e.filePath)}catch{this.before=""}else e.before===null?this.before="":this.before=e.before;e.after?typeof this.before=="object"||typeof e.after=="object"?this.changes=(0,I.diffJson)(this.before,e.after):this.changes=(0,I.diffLines)(this.before,e.after):this.changes=[]}fileName(){return z.default.relative(this.rootPath,this.filePath)}write(){this.after&&(typeof this.after=="object"?$.default.writeJsonSync(this.filePath,this.after,{spaces:2}):$.default.writeFileSync(this.filePath,this.after))}additions(){return this.changes.filter(e=>e.added).length}deletions(){return this.changes.filter(e=>e.removed).length}hasChanges(){return this.additions()>0||this.deletions()>0}log(e){e.diff?(this.changes.forEach(t=>{t.added?process.stdout.write(S.default.green(t.value)):t.removed?process.stdout.write(S.default.red(t.value)):process.stdout.write(S.default.dim(t.value))}),console.log(he.default.EOL)):console.log(this.after)}};var p=i(require("chalk")),C=class{constructor(e){this.transform=e.transformer,this.dry=e.dry}modified(...e){console.log(p.default.green(" MODIFIED "),...e,this.dry?p.default.dim("(dry run)"):"")}unchanged(...e){console.log(p.default.gray(" UNCHANGED "),...e,this.dry?p.default.dim("(dry run)"):"")}skipped(...e){console.log(p.default.yellow(" SKIPPED "),...e,this.dry?p.default.dim("(dry run)"):"")}error(...e){console.log(p.default.red(" ERROR "),...e,this.dry?p.default.dim("(dry run)"):"")}info(...e){console.log(p.default.bold(" INFO "),...e,this.dry?p.default.dim("(dry run)"):"")}};var Q=class{constructor(e){this.modifications={};this.transform=e.transformer,this.rootPath=e.rootPath,this.dry=e.dry,this.print=e.print,this.logger=new C(e)}abortTransform(e){return this.logger.error(e.reason),{fatalError:new Error(e.reason),changes:e.changes||{}}}modifyFile(e){this.modifications[e.filePath]=new M({rootPath:this.rootPath,...e})}finish(){let e={changes:{}};return Object.keys(this.modifications).forEach(n=>{let o=this.modifications[n],s={action:"unchanged",additions:o.additions(),deletions:o.deletions()};if(o.hasChanges()){if(this.dry)s.action="skipped",this.logger.skipped(j.default.dim(o.fileName()));else try{o.write(),s.action="modified",this.logger.modified(j.default.bold(o.fileName()))}catch(a){let m="Unknown error";a instanceof Error&&(m=a.message),s.error=new Error(m),s.action="error",this.logger.error(o.fileName(),m)}this.print&&o.log({diff:!0})}else this.logger.unchanged(j.default.dim(o.fileName()));e.changes[o.fileName()]=s}),Object.keys(e.changes).some(n=>e.changes[n].action==="error")?this.abortTransform({reason:"Encountered an error while transforming files",changes:e.changes}):e}static logResults(e){let t=Object.keys(e.changes);if(console.log(),t.length>0){console.log(j.default.bold("Results:"));let n={};t.forEach(o=>{var a;let s=e.changes[o];n[o]={action:s.action,additions:s.additions,deletions:s.deletions,error:((a=s.error)==null?void 0:a.message)||"None"}}),console.table(n),console.log()}}},E=Q;var ye=i(require("path")),be=require("fs-extra"),Ne=["package.json","turbo.json",".git"];function X({directory:r}){return Ne.some(e=>(0,be.existsSync)(ye.default.join(r,e)))}function h({message:r,success:e}){return e?(console.log(f.default.bold(f.default.green("Migration completed"))),r&&console.log(r),process.exit(0)):(console.log(f.default.bold(f.default.red("Migration failed"))),r&&console.log(r),process.exit(1))}async function N(r,e){e.dry||T({directory:r,force:e.force});let t=await ke.default.prompt([{type:"input",name:"directoryInput",message:"Where is the root of the repo to migrate?",when:!r,default:".",validate:c=>{let{exists:u,absolute:w}=k({directory:c});return u?!0:`Directory ${f.default.dim(`(${w})`)} does not exist`},filter:c=>c.trim()}]),{directoryInput:n=r}=t,{exists:o,absolute:s}=k({directory:n});if(!o)return h({success:!1,message:`Directory ${f.default.dim(`(${s})`)} does not exist`});if(!X({directory:s}))return h({success:!1,message:`Directory (${f.default.dim(s)}) does not appear to be a repository`});let a=ce(n,e);if(!a)return h({success:!1,message:`Unable to infer the version of turbo being used by ${r}`});let m=e.to;try{m=await B(e)}catch(c){let u="UNKNOWN_ERROR";return c instanceof Error&&(u=c.message),h({success:!1,message:u})}if(!m)return h({success:!1,message:"Unable to fetch the latest version of turbo"});if(a===m)return h({success:!0,message:`Nothing to do, current version (${f.default.bold(a)}) is the same as the requested version (${f.default.bold(m)})`});let d=de({fromVersion:a,toVersion:m});if(d.length===0&&console.log(`No codemods required to migrate from ${a} to ${m}`,x.default.EOL),console.log(`Upgrading turbo from ${f.default.bold(a)} to ${f.default.bold(m)} (${d.length===0?"no codemods required":`${d.length} required codemod${d.length===1?"":"s"}`})`,x.default.EOL),d.map((c,u)=>{console.log(`(${u+1}/${d.length}) ${f.default.bold(`Running ${c.value}`)}`);let w=c.transformer({root:n,options:e});return E.logResults(w),w}).some(c=>c.fatalError||Object.keys(c.changes).some(u=>c.changes[u].error)))return h({success:!1,message:"Could not complete migration due to codemod errors. Please fix the errors and try again."});let y=H({directory:n,to:e.to});if(!y)return h({success:!1,message:"Unable to determine upgrade command"});e.install?e.dry?console.log(`Upgrading turbo with ${f.default.bold(y)} ${f.default.dim("(dry run)")}`,x.default.EOL):(console.log(`Upgrading turbo with ${f.default.bold(y)}`,x.default.EOL),(0,we.execSync)(y,{cwd:n})):console.log(`Upgrade turbo with ${f.default.bold(y)}`,x.default.EOL),h({success:!0})}var D=i(require("chalk")),ve=i(require("inquirer"));async function L(r,e,t){let n=P();if(t.list)return console.log(n.map(c=>`- ${D.default.cyan(c.value)}`).join(`
|
|
5
|
+
`)),process.exit(0);t.dry||T({directory:e,force:t.force});let o=await ve.default.prompt([{type:"input",name:"directoryInput",message:"Where is the root of the repo where the transform should run?",when:!e,default:".",validate:c=>{let{exists:u,absolute:w}=k({directory:c});return u?!0:`Directory ${D.default.dim(`(${w})`)} does not exist`},filter:c=>c.trim()},{type:"list",name:"transformerInput",message:"Which transform would you like to apply?",when:!r,pageSize:n.length,choices:n}]),{directoryInput:s=e,transformerInput:a=r}=o,{exists:m,absolute:d}=k({directory:s});if(!m)return console.error(`Directory ${D.default.dim(`(${d})`)} does not exist`),process.exit(1);let re=n.map(c=>c.value),q=n.find(c=>c.value===a);if(!q)return console.error(`Invalid transform choice ${D.default.dim(`(${r})`)}, pick one of:`),console.error(re.map(c=>`- ${c}`).join(`
|
|
6
|
+
`)),process.exit(1);let y=q.transformer({root:d,options:t});if(y.fatalError)return process.exit(1);E.logResults(y)}var Z=i(require("chalk")),xe=i(require("update-check"));var G={name:"@turbo/codemod",version:"1.7.1-canary.5",description:"Provides Codemod transformations to help upgrade your Turborepo codebase when a feature is deprecated.",homepage:"https://turbo.build/repo",license:"MPL-2.0",repository:{type:"git",url:"https://github.com/vercel/turbo",directory:"packages/turbo-codemod"},bugs:{url:"https://github.com/vercel/turbo/issues"},bin:"dist/cli.js",scripts:{build:"tsup",test:"jest",lint:"eslint src/**/*.ts","check-types":"tsc --noEmit","add-transformer":"plop"},dependencies:{axios:"0.27.2",chalk:"2.4.2",commander:"^9.5.0",diff:"^5.1.0","find-up":"4.1.0","fs-extra":"^10.0.0","gradient-string":"^2.0.0",inquirer:"^8.2.4","inquirer-file-tree-selection-prompt":"^1.0.19","is-git-clean":"^1.1.0",ora:"4.1.1",semver:"^7.3.7","update-check":"^1.5.4"},devDependencies:{"@types/chalk-animation":"^1.6.0","@types/diff":"^5.0.2","@types/fs-extra":"^9.0.13","@types/gradient-string":"^1.1.2","@types/inquirer":"^8.2.0","@types/jest":"^27.4.0","@types/node":"^16.11.12","@types/semver":"^7.3.9","@types/uuid":"^9.0.0",deepmerge:"^4.2.2",eslint:"^7.23.0",jest:"^27.4.3",plop:"^3.1.1",semver:"^7.3.5","ts-jest":"^27.1.1",tsconfig:"workspace:*",tsup:"^5.10.3","turbo-test-utils":"workspace:*","turbo-types":"workspace:*",typescript:"^4.5.5"},files:["dist"],publishConfig:{access:"public"}};var Ge=(0,xe.default)(G).catch(()=>null);async function V(){try{let r=await Ge;if(r!=null&&r.latest){let e=b(process.cwd());console.log(),console.log(Z.default.yellow.bold("A new version of `@turbo/codemod` is available!")),console.log("You can update by running: "+Z.default.cyan(e==="yarn"?"yarn global add @turbo/codemod":e==="pnpm"?"pnpm i -g @turbo/codemod":"npm i -g @turbo/codemod")),console.log()}process.exit()}catch{}}var W=new Pe.Command;W.name("@turbo/codemod").description("Codemod transformations to help upgrade your Turborepo codebase when a feature is deprecated.").version(G.version,"-v, --version","output the current version");W.command("migrate").aliases(["update","upgrade"]).description("Migrate a project to the latest version of Turborepo").argument("[path]","Directory where the transforms should be applied").option("--from <version>","Specify the version to migrate from (default: current version)").option("--to <version>","Specify the version to migrate to (default: latest)").option("--install","Install new version of turbo after migration",!0).option("--force","Bypass Git safety checks and forcibly run codemods",!1).option("--dry","Dry run (no changes are made to files)",!1).option("--print","Print transformed files to your terminal",!1).action(N);W.command("transform",{isDefault:!0}).description("Apply a single code transformation to a project").argument("[transform]","The transformer to run").argument("[path]","Directory where the transforms should be applied").option("--force","Bypass Git safety checks and forcibly run codemods",!1).option("--list","List all available transforms",!1).option("--dry","Dry run (no changes are made to files)",!1).option("--print","Print transformed files to your terminal",!1).action(L);W.parseAsync().then(V).catch(async r=>{console.log(),r.command?console.log(` ${ee.default.cyan(r.command)} has failed.`):(console.log(ee.default.red("Unexpected error. Please report it as a bug:")),console.log(r)),console.log(),await V(),process.exit(1)});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turbo/codemod",
|
|
3
|
-
"version": "1.7.1-canary.
|
|
3
|
+
"version": "1.7.1-canary.5",
|
|
4
4
|
"description": "Provides Codemod transformations to help upgrade your Turborepo codebase when a feature is deprecated.",
|
|
5
5
|
"homepage": "https://turbo.build/repo",
|
|
6
6
|
"license": "MPL-2.0",
|
|
@@ -46,9 +46,9 @@
|
|
|
46
46
|
"ts-jest": "^27.1.1",
|
|
47
47
|
"tsconfig": "0.0.0",
|
|
48
48
|
"tsup": "^5.10.3",
|
|
49
|
+
"turbo-test-utils": "0.0.0",
|
|
49
50
|
"turbo-types": "0.0.0",
|
|
50
|
-
"typescript": "^4.5.5"
|
|
51
|
-
"uuid": "^9.0.0"
|
|
51
|
+
"typescript": "^4.5.5"
|
|
52
52
|
},
|
|
53
53
|
"files": [
|
|
54
54
|
"dist"
|