@lsbjordao/type-taxon-script 1.1.1 → 1.1.3
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/package.json +1 -1
- package/readme.md +17 -11
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lsbjordao/type-taxon-script",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"author": "Lucas Jordão <tucarj@gmail.com> & André Eppinghaus <andreeppinghaus@gmail.com> & Vicente Calfo <vicentecalfo@gmail.com>",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"description": "TypeTaxonScript",
|
package/readme.md
CHANGED
|
@@ -16,7 +16,7 @@ Visual Studio Code (VS Code) is a versatile code editor that provides a user-fri
|
|
|
16
16
|
|
|
17
17
|
## Clone the repository from GitHub in VS Code
|
|
18
18
|
|
|
19
|
-
To clone the *Mimosa* project repository for TTS from GitHub, follow these steps:
|
|
19
|
+
To clone the *Mimosa* project repository for TTS from GitHub (https://github.com/lsbjordao/TTS-Mimosa), follow these steps:
|
|
20
20
|
|
|
21
21
|
1. In VS Code, access the Command Palette by pressing `Ctrl + Shift + P` (Windows/Linux) or `Cmd + Shift + P` (macOS).
|
|
22
22
|
2. Type `Git: Clone` and select the option that appears.
|
|
@@ -35,9 +35,21 @@ To open the TTS project directory in VS Code:
|
|
|
35
35
|
4. Click on the TTS project directory to select it.
|
|
36
36
|
5. Click the `Open` button.
|
|
37
37
|
|
|
38
|
-
## Installing
|
|
38
|
+
## Installing TypeScript (TS) globally
|
|
39
39
|
|
|
40
|
-
Within VS Code, open your terminal and execute the command
|
|
40
|
+
Within VS Code, open your terminal and execute the command bellow, following these steps:
|
|
41
|
+
|
|
42
|
+
1. Navigate to the top menu and select Terminal.
|
|
43
|
+
2. From the dropdown menu, choose New Terminal.
|
|
44
|
+
3. In the terminal, type and execute the following command:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm install -g type-taxon-script
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Installing TTS package globally
|
|
51
|
+
|
|
52
|
+
Within a terminal in VS Code, type and execute the following command:
|
|
41
53
|
|
|
42
54
|
1. Navigate to the top menu and select `Terminal`.
|
|
43
55
|
2. From the dropdown menu, choose `New Terminal`.
|
|
@@ -81,14 +93,6 @@ tts new --genus Mimosa --species epithet
|
|
|
81
93
|
|
|
82
94
|
After the process, a new file named `Mimosa_epithet.ts` will be created in the `./output` directory. To access this script file, simply hold down the `Ctrl` key and click on the file path displayed in the console. However, before you begin editing the script, it is important to relocate this file to the `./taxon` directory, as the script specifically functions within that directory. Outside this directory, the script will not works properly. Opening the script outside of this directory will trigger multiple dependency errors.
|
|
83
95
|
|
|
84
|
-
## Exporting JSON database
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
tts export --genus Mimosa
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
96
|
## Importing from `.csv` file
|
|
93
97
|
|
|
94
98
|
It is also possible to import data of multiple taxa from a `.csv` file with a header in the following manner:
|
|
@@ -151,6 +155,8 @@ To export all taxa inside `./taxon/Mimosa`, type:
|
|
|
151
155
|
tts export --genus Mimosa
|
|
152
156
|
```
|
|
153
157
|
|
|
158
|
+
|
|
159
|
+
|
|
154
160
|
If you intend to generate a database containing a specific list of taxa from the directory `./taxon/Mimosa`, edit the `./input/taxonToImport.csv` file accordingly. After making the necessary edits, execute the following command:
|
|
155
161
|
|
|
156
162
|
```bash
|