Check if LICENSE exists. #4

harjyotbagga · 2022-02-21T07:11:51Z

In continuation to PR #1605

Signed off by: Harjyot Bagga baggaharjyot@gmail.com
PR to resolve Issue #39

Checks if a LICENSE exists in the Project Directory, if so it lists and asks the user if they want to still add another LICENSE.
If LICENSE exists, confirms if the user wishes to over-write the existing LICENSE.
Changed default LICENSE to be LICENSE["empty"] instead of LICENSE["none"]
LICENSE["none"] would be used if a user is unwilling to create a license.

Commands:
To create a project with no LICENSE:
cobra init proj-name -l none

In case of existing LICENSE:

Post Checks:

Built Successfully
All tests passed successfully

CLAassistant · 2022-02-21T07:11:57Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

harjyotbagga seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

harjyotbagga · 2022-02-21T07:12:55Z

cmd/licenses.go

@@ -41,6 +41,7 @@ type License struct {
 func init() {
 	// Allows a user to not use a license.
 	Licenses["none"] = License{"None", []string{"none", "false"}, "", ""}
+	Licenses["empty"] = License{"Empty", []string{"empty", "blank"}, "", ""}


New License type. Also set as the default type.
None License type used to omit License creation.

harjyotbagga · 2022-02-21T07:13:09Z

cmd/licenses.go

-	// If user didn't set any license, use none by default
-	return Licenses["none"]
+	// If user didn't set any license, use empty by default
+	return Licenses["empty"]


Changed Default License type.

harjyotbagga · 2022-02-21T07:13:43Z

cmd/project.go

+		if info.IsDir() && filepath.Ext(path) != ".txt" && filepath.Ext(path) != ".md" && filepath.Ext(path) != "" {
+			return nil
+		}
+		reg := regexp.MustCompile(`(?i).*license\.?.*`)


Used Regex to find License in the project directory.
Regex: Should contain the word license and should not have an extension / should be a .txt or .md

harjyotbagga · 2022-02-21T07:14:18Z

cmd/project.go

+		for _, license := range licensesExist {
+			fmt.Printf("  %s\n", license)
+		}
+		fmt.Print("Would you like still to add a license? [Y/n] ")


Confirms to add a LICENSE if one exists.

harjyotbagga · 2022-02-21T07:14:28Z

cmd/project.go

+			}
+		}
+		if licenseFound {
+			fmt.Print("LICENSE exists. Would you like to overwrite it? [Y/n] ")


Ask user to overwrite the LICENSE file if exists.

harjyotbagga · 2022-02-21T07:14:37Z

cmd/root.go

@@ -50,7 +50,7 @@ func init() {
 	cobra.CheckErr(viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author")))
 	cobra.CheckErr(viper.BindPFlag("useViper", rootCmd.PersistentFlags().Lookup("viper")))
 	viper.SetDefault("author", "NAME HERE <EMAIL ADDRESS>")
-	viper.SetDefault("license", "none")
+	viper.SetDefault("license", "empty")


Default License changed.

harjyotbagga

Changes proposed.
@johnSchnake please have a look.

johnSchnake · 2022-02-21T15:28:42Z

LGTM; built locally and overwrites it when I say 'y', doesn't otherwise.

Going to ping someone else for final merging only because of the change of default license; being new to the project I want to be extra cautious about that.

@jpmcb Can you confirm if changing the default license to empty is appropriate? E.g. default to leaving the license files alone. Maybe a nit would be naming; would ignore or something else be more appropriate? Functionality here seems fine though.

harjyotbagga · 2022-02-22T02:55:15Z

I was thinking on similar lines, but as far I remember I came across an issue in cobra suggesting to keep an empty license as the default one.
However I am up for anything.

jpmcb

This is looking great! Thanks for bringing this feature over so quickly.

We still need to tag this repo so that downstream users can consume it. After that happens, we can start to talk about bringing in features, etc. Blocking on this PR review for now until we go ahead with that.

harjyotbagga · 2022-02-23T08:37:45Z

Sure. Whenever that's done, we can add this feature.
If there are any changes to be done from my end, please HMU. 🙌🏻

harjyotbagga · 2022-04-05T18:18:55Z

Heyy, since it's been more than I month. I just wanted to check upon this PR. Is there anything to be done from my end? Or what is the plan that we are looking at ahead?

github-actions · 2022-06-05T00:09:36Z

This PR is being marked as stale due to a long period of inactivity

jpmcb · 2022-07-27T20:48:36Z

@harjyotbagga - my apologies, it's been a crazy summer here and I haven't had alot of time to dedicate into cobra.

We'll get this in soon - this is a great feature add and thank you for your patience!

harjyotbagga · 2022-07-27T20:53:30Z

Thank you so much for the reply! Super happy to contribute. Please let me know if there are any changes to be done from my end!

github-actions · 2022-09-28T00:17:03Z

This PR is being marked as stale due to a long period of inactivity

github-actions · 2022-11-29T00:09:58Z

This PR is being marked as stale due to a long period of inactivity

harjyotbagga · 2022-11-30T17:39:52Z

@jpmcb Is there anything to be done from my end?

github-actions · 2023-01-30T00:08:15Z

This PR is being marked as stale due to a long period of inactivity

github-actions · 2023-04-02T00:09:11Z

This PR is being marked as stale due to a long period of inactivity

github-actions · 2023-06-02T00:09:12Z

This PR is being marked as stale due to a long period of inactivity

check if LICENSE exists.

6ed77f4

harjyotbagga commented Feb 21, 2022

View reviewed changes

harjyotbagga mentioned this pull request Feb 21, 2022

Checks if LICENSE exists. spf13/cobra#1605

Closed

2 tasks

jpmcb requested changes Feb 23, 2022

View reviewed changes

github-actions bot added the kind/stale label Jun 5, 2022

jpmcb self-requested a review July 27, 2022 20:48

github-actions bot removed the kind/stale label Jul 30, 2022

github-actions bot added kind/stale and removed kind/stale labels Sep 28, 2022

github-actions bot added kind/stale and removed kind/stale labels Nov 29, 2022

github-actions bot added the kind/stale label Jan 30, 2023

github-actions bot removed the kind/stale label Jan 31, 2023

github-actions bot added kind/stale and removed kind/stale labels Apr 2, 2023

harjyotbagga mentioned this pull request Apr 26, 2023

Don't touch my licence #39

Open

github-actions bot added kind/stale and removed kind/stale labels Jun 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check if LICENSE exists. #4

Check if LICENSE exists. #4

harjyotbagga commented Feb 21, 2022

CLAassistant commented Feb 21, 2022 •

edited

harjyotbagga Feb 21, 2022

harjyotbagga Feb 21, 2022

harjyotbagga Feb 21, 2022

harjyotbagga Feb 21, 2022

harjyotbagga Feb 21, 2022

harjyotbagga Feb 21, 2022

harjyotbagga left a comment

johnSchnake commented Feb 21, 2022

harjyotbagga commented Feb 22, 2022

jpmcb left a comment

harjyotbagga commented Feb 23, 2022

harjyotbagga commented Apr 5, 2022

github-actions bot commented Jun 5, 2022

jpmcb commented Jul 27, 2022

harjyotbagga commented Jul 27, 2022

github-actions bot commented Sep 28, 2022

github-actions bot commented Nov 29, 2022

harjyotbagga commented Nov 30, 2022

github-actions bot commented Jan 30, 2023

github-actions bot commented Apr 2, 2023

github-actions bot commented Jun 2, 2023

Check if LICENSE exists. #4

Are you sure you want to change the base?

Check if LICENSE exists. #4

Conversation

harjyotbagga commented Feb 21, 2022

In continuation to PR #1605

CLAassistant commented Feb 21, 2022 • edited

harjyotbagga Feb 21, 2022

Choose a reason for hiding this comment

harjyotbagga Feb 21, 2022

Choose a reason for hiding this comment

harjyotbagga Feb 21, 2022

Choose a reason for hiding this comment

harjyotbagga Feb 21, 2022

Choose a reason for hiding this comment

harjyotbagga Feb 21, 2022

Choose a reason for hiding this comment

harjyotbagga Feb 21, 2022

Choose a reason for hiding this comment

harjyotbagga left a comment

Choose a reason for hiding this comment

johnSchnake commented Feb 21, 2022

harjyotbagga commented Feb 22, 2022

jpmcb left a comment

Choose a reason for hiding this comment

harjyotbagga commented Feb 23, 2022

harjyotbagga commented Apr 5, 2022

github-actions bot commented Jun 5, 2022

jpmcb commented Jul 27, 2022

harjyotbagga commented Jul 27, 2022

github-actions bot commented Sep 28, 2022

github-actions bot commented Nov 29, 2022

harjyotbagga commented Nov 30, 2022

github-actions bot commented Jan 30, 2023

github-actions bot commented Apr 2, 2023

github-actions bot commented Jun 2, 2023

CLAassistant commented Feb 21, 2022 •

edited