learn-tool 0.0.22 → 0.0.23
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.
- checksums.yaml +4 -4
- data/README.md +22 -5
- data/lib/learn-tool/learn-base.rb +1 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8a512d49360188f0eb9556ec11b02fc47a7fbee31216c45d92ebdf1407265e39
|
|
4
|
+
data.tar.gz: 635870bc64c05d5b994c3a45c2b38565a5e53012c6abe46222f398af8aa8e0a3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a9baa9b7a741ce181470fa7f051641d737f7f80fb8da4b2e7bdc4ef8dffa14df1ae576cf124f9bafab33dbb9fba7049521addeccbeb076edb3c512a3d678b175
|
|
7
|
+
data.tar.gz: eaec1d1f16e457a2ea30a2dba75db7f716987bbacfc01eeda1fde853452c9cc46508c7612454c3fbdd70a10bcf212a7aaa2719503272a1ff717da5564cd2bc85
|
data/README.md
CHANGED
|
@@ -39,7 +39,7 @@ To create a new repository, navigate to the folder where you'd like your
|
|
|
39
39
|
repo to be duplicated locally and type:
|
|
40
40
|
|
|
41
41
|
```sh
|
|
42
|
-
learn-tool create
|
|
42
|
+
learn-tool --create
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
Follow the prompts to create a blank readme, code-along or lab repository. The
|
|
@@ -59,7 +59,7 @@ For other lesson types, start with a Readme.
|
|
|
59
59
|
To duplicate an existing repository, type:
|
|
60
60
|
|
|
61
61
|
```sh
|
|
62
|
-
learn-tool duplicate
|
|
62
|
+
learn-tool --duplicate
|
|
63
63
|
```
|
|
64
64
|
|
|
65
65
|
This command will make an exact copy of another repository. For example, you
|
|
@@ -70,7 +70,7 @@ the configuration of an existing lab.
|
|
|
70
70
|
consider creating a fork and submit a pull request on the **original lesson**
|
|
71
71
|
rather than creating an altered duplicate.
|
|
72
72
|
|
|
73
|
-
## Lesson Repair
|
|
73
|
+
## Lesson Linting and Repair
|
|
74
74
|
|
|
75
75
|
If you already have a repository or created one manually, it is important that
|
|
76
76
|
certain files are present:
|
|
@@ -83,13 +83,30 @@ certain files are present:
|
|
|
83
83
|
- `CONTRIBUTING.md` - This file contains information on how to contribute to our
|
|
84
84
|
content.
|
|
85
85
|
|
|
86
|
+
To check if these files are present and correct, from the lesson directory type:
|
|
87
|
+
|
|
88
|
+
```sh
|
|
89
|
+
learn-tool --lint
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Alternatively, you can provide an absolute path to the directory you would like to lint:
|
|
93
|
+
|
|
94
|
+
```sh
|
|
95
|
+
learn-tool --lint /Users/johnboy/lessons/jukebox-cli
|
|
96
|
+
```
|
|
97
|
+
|
|
86
98
|
To quickly add or fix these files, type:
|
|
87
99
|
|
|
88
100
|
```sh
|
|
89
|
-
learn-tool repair
|
|
101
|
+
learn-tool --repair
|
|
90
102
|
```
|
|
91
103
|
|
|
92
|
-
This command will replace or add the required files to the current repository.
|
|
104
|
+
This command will replace or add the required files to the current repository. You can pass an absolute path of another directory you would like to repair:
|
|
105
|
+
|
|
106
|
+
```sh
|
|
107
|
+
learn-tool --repair /Users/johnboy/lessons/jukebox-cli
|
|
108
|
+
```
|
|
109
|
+
**Warning**: Repairing will overwrite any existing support files.
|
|
93
110
|
|
|
94
111
|
## Resources
|
|
95
112
|
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
require 'pry'
|
|
2
1
|
class LearnBase
|
|
3
2
|
|
|
4
3
|
GITHUB_ORG = 'https://api.github.com/repos/learn-co-curriculum/'
|
|
@@ -108,4 +107,4 @@ class LearnBase
|
|
|
108
107
|
result = Open3.capture2e('ssh -T git@github.com').first
|
|
109
108
|
result.include?("You've successfully authenticated")
|
|
110
109
|
end
|
|
111
|
-
end
|
|
110
|
+
end
|