Import gist by rajasegar · Pull Request #75 · rwjblue/codemod-cli

rajasegar · 2019-11-18T05:32:08Z

Add import command (global)
Test cases for import (global)
Add import command (local )
Test cases for import command (local )
Add export command (local )
Update README with the import command info

1. Gists are created perfectly 2. But when we access it in ast-explorer we are getting error like Failed to parse revision

rajasegar · 2019-11-18T10:02:19Z

@rwjblue Please let me know your comments whether we are going in the right direction.

1. Move api keys to .env file using dotenv 2. Added test cases for new with import url

rwjblue · 2019-11-26T17:30:27Z

commands/global/new.js

+    require('dotenv').config();
+    const Octokit = require('@octokit/rest');
+    const octokit = new Octokit({ auth: process.env.CODEMOD_CLI_API_KEY });
+    let codemodDir = `${process.cwd()}/${projectName}/transforms/${codemodName}`;


Do we need this? Can we download the actual file directly (without needing an API key)?

I'm thinking like, from:

https://gist.githubusercontent.com/astexplorer/6f3bf899542dbe21e0474a2a74b2ffc9/raw/c23b658b268c2e5b644fed7f1a360433748e7f71/transform.js

I think yes, but in case of export we need an api to create gists, so I thought we can use this. What do you think?

rwjblue · 2019-11-26T17:34:44Z

commands/global/new.js

+    fs.outputFileSync(
+      `${codemodDir}/README.md`,
+      stripIndent`
+      # ${codemodName}\n
+
+      ## Usage
+
+      \`\`\`
+      npx ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
+
+      # or
+
+      yarn global add ${projectName}
+      ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
+      \`\`\`
+
+      ## Input / Output
+
+      <!--FIXTURES_TOC_START-->
+      <!--FIXTURES_TOC_END-->
+
+      <!--FIXTURES_CONTENT_START-->
+      <!--FIXTURES_CONTENT_END-->
+    `,
+      'utf8'
+    );


Can you abstract this so we don't slowly diverge the README.md contents?

Sure, working on it.

rwjblue · 2019-11-26T17:35:20Z

commands/local/export.js

+  let { codemodName } = options;
+
+  const Octokit = require('@octokit/rest');
+  const octokit = new Octokit({ auth: 'acabfddbefb244cb3e674fa84046a907c78f2294' });


🤔 - Seems odd to hard code this here? Is this a mistake?

Yep, my bad, will remove that.

rwjblue · 2019-11-26T17:35:38Z

commands/local/export.js

+      // https://api.github.com/gists/de5cff0a12c2aaf129f94b775306af6f
+      console.log(data);


Just notating for removal in the future

rwjblue · 2019-11-26T17:36:00Z

commands/local/export.js

+    .create({
+      files,
+    })
+    .then(({ data }) => {


I think we can use async/await here instead of manual chaining.

rwjblue · 2019-11-26T17:36:47Z

commands/local/import.js

+  fs.outputFileSync(
+    `${codemodDir}/README.md`,
+    stripIndent`
+      # ${codemodName}\n
+
+      ## Usage
+
+      \`\`\`
+      npx ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
+
+      # or
+
+      yarn global add ${projectName}
+      ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
+      \`\`\`
+
+      ## Input / Output
+
+      <!--FIXTURES_TOC_START-->
+      <!--FIXTURES_TOC_END-->
+
+      <!--FIXTURES_CONTENT_START-->
+      <!--FIXTURES_CONTENT_END-->
+    `,
+    'utf8'
+  );


Lets use a shared function to generate these README.md's, I don't want them to slowly get out of sync due to the duplication.

rwjblue · 2019-11-26T17:37:21Z

package-lock.json

@@ -0,0 +1,11641 @@
+{


I think we are using a yarn.lock, can you delete this?

OK, I got used to npm so much , I forgot to remove, will do it right away.

1. Added new lib for readme-support 2. Project readme abstracted to readme-support 3. Codemod readme abstracted to readme-support 4. Removed console.logs and api keys

1. Removed package-lock 2. Update yarn.lock

rajasegar · 2020-01-04T10:08:18Z

@rwjblue Do you mind if I create a separate PR for export, after figuring out the issues with ast-explorer?

1. Add new with import command example in Readme 2. Clean up some comments and console.logs 3. Added error handling to new and import commands

1. Made changes for downloading transform with node's built-in request object in new and import commands 2. Remove octokit from package.json and yarn.lock 3. Removed export command

rwjblue · 2020-03-19T14:59:21Z

@rwjblue Do you mind if I create a separate PR for export, after figuring out the issues with ast-explorer?

No problem, that seems fine to me.

rwjblue · 2020-03-19T14:59:35Z

I'm going to try to get CI passing again this week.

rajasegar added 5 commits November 17, 2019 19:56

[FEAT] Add local import command

b4cd0b5

[CHORE] Add TODO comment and cleanup console logs

1024984

[BUGFIX] Adding catch block for reading gist promise

24f155d

[CHORE] Parsing ast-explorer url using regex

e645135

[FEAT] Adding local export command

7744e3f

1. Gists are created perfectly 2. But when we access it in ast-explorer we are getting error like Failed to parse revision

[FEAT] Adding url and codemod options to new command

654f435

1. Move api keys to .env file using dotenv 2. Added test cases for new with import url

rwjblue reviewed Nov 26, 2019

View reviewed changes

rajasegar added 4 commits January 4, 2020 07:44

[CHORE] Review comments Phase rwjblue#1

b3e8539

1. Added new lib for readme-support 2. Project readme abstracted to readme-support 3. Codemod readme abstracted to readme-support 4. Removed console.logs and api keys

[CHORE] Review comments Phase-2

7aa0ea4

1. Removed package-lock 2. Update yarn.lock

[CHORE] Fix failing test for new with import

922a429

[CHORE] Add tests for local import command

90659a5

rajasegar added 4 commits January 4, 2020 15:42

[DOCS] Add import command info to readme

15a19f0

[CHORE] Gist import error handling

797cc1d

1. Add new with import command example in Readme 2. Clean up some comments and console.logs 3. Added error handling to new and import commands

chore: Remove octokit api for downloading transforms

121a53a

1. Made changes for downloading transform with node's built-in request object in new and import commands 2. Remove octokit from package.json and yarn.lock 3. Removed export command

fix: test cases for test.js and imported transform.js

5658ea5

rajasegar changed the title ~~WIP Import gist~~ Import gist Jan 28, 2020

		// https://api.github.com/gists/de5cff0a12c2aaf129f94b775306af6f
		console.log(data);

Comments

Conversation

rajasegar commented Nov 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rajasegar commented Nov 18, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rajasegar commented Jan 4, 2020

Uh oh!

rwjblue commented Mar 19, 2020

Uh oh!

rwjblue commented Mar 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rajasegar commented Nov 18, 2019 •

edited

Loading