@nshiab/setup-data-project 1.0.35 → 1.0.37

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.
Files changed (7) hide show
  1. package/esm/helpers/ensureAgents.js +3 -3
  2. package/esm/helpers/ensureReadme.d.ts.map +1 -1
  3. package/esm/helpers/ensureReadme.js +4 -2
  4. package/package.json +1 -1
  5. package/script/helpers/ensureAgents.js +3 -3
  6. package/script/helpers/ensureReadme.d.ts.map +1 -1
  7. package/script/helpers/ensureReadme.js +4 -2
package/esm/helpers/ensureAgents.js CHANGED
@@ -88,11 +88,11 @@ Always use "sda/main.ts" as the entry point.
88
88
 
89
89
  If you need to create other TypeScript files, create them in the "sda/helpers" folder. Prioritize the use of helper functions to keep the code well organized and maintainable, with one helper function per file, with the file named after the function. Prioritize default exports for helper functions.
90
90
 
91
- Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate.
91
+ Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate. When testing a helper from "sda/helpers/functionName.ts", name its test file "sda/tests/functionName.test.ts".
92
92
 
93
- If you need to download data, always put the files in the "sda/data" folder, which is gitignored.
93
+ If you need to download data, always put the files in the "sda/data" folder, which is ignored by Git.
94
94
 
95
- If you need to output data to a file, always put the file in the "sda/output" folder.
95
+ If you need to output data to a file, always put the file in the "sda/output" folder, which is also ignored by Git.
96
96
  ${libraryGuidance}`;
97
97
  if (journalismFunctions !== "") {
98
98
  content += `
package/esm/helpers/ensureReadme.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QA0DjC"}
1
+ {"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QA4DjC"}
package/esm/helpers/ensureReadme.js CHANGED
@@ -36,12 +36,14 @@ Here's the recommended workflow:
36
36
  - Put your raw data in the \`sda/data\` folder. Note that this folder is
37
37
  ignored by Git.
38
38
  - Use the \`sda/main.ts\` file to process your raw data. Write the
39
- results to the \`sda/output\` folder.
39
+ results to the \`sda/output\` folder, which is also ignored by Git.
40
+ - Put your tests in the \`sda/tests\` folder.
40
41
 
41
- When working on your project, use the following command:
42
+ When working on your project, use the following commands:
42
43
 
43
44
  - \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies.
44
45
  Whenever you save changes, the data will be reprocessed.
46
+ - \`${runCommand} all-tests\` will run the project's test command.
45
47
  - \`${runCommand} clean\` will remove cache and temporary files, if present.
46
48
 
47
49
  Have fun!`,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nshiab/setup-data-project",
3
- "version": "1.0.35",
3
+ "version": "1.0.37",
4
4
  "description": "Quickly kick off your data project using the simple-data-analysis and journalism libraries.",
5
5
  "repository": {
6
6
  "type": "git",
package/script/helpers/ensureAgents.js CHANGED
@@ -91,11 +91,11 @@ Always use "sda/main.ts" as the entry point.
91
91
 
92
92
  If you need to create other TypeScript files, create them in the "sda/helpers" folder. Prioritize the use of helper functions to keep the code well organized and maintainable, with one helper function per file, with the file named after the function. Prioritize default exports for helper functions.
93
93
 
94
- Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate.
94
+ Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate. When testing a helper from "sda/helpers/functionName.ts", name its test file "sda/tests/functionName.test.ts".
95
95
 
96
- If you need to download data, always put the files in the "sda/data" folder, which is gitignored.
96
+ If you need to download data, always put the files in the "sda/data" folder, which is ignored by Git.
97
97
 
98
- If you need to output data to a file, always put the file in the "sda/output" folder.
98
+ If you need to output data to a file, always put the file in the "sda/output" folder, which is also ignored by Git.
99
99
  ${libraryGuidance}`;
100
100
  if (journalismFunctions !== "") {
101
101
  content += `
package/script/helpers/ensureReadme.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QA0DjC"}
1
+ {"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QA4DjC"}
package/script/helpers/ensureReadme.js CHANGED
@@ -39,12 +39,14 @@ Here's the recommended workflow:
39
39
  - Put your raw data in the \`sda/data\` folder. Note that this folder is
40
40
  ignored by Git.
41
41
  - Use the \`sda/main.ts\` file to process your raw data. Write the
42
- results to the \`sda/output\` folder.
42
+ results to the \`sda/output\` folder, which is also ignored by Git.
43
+ - Put your tests in the \`sda/tests\` folder.
43
44
 
44
- When working on your project, use the following command:
45
+ When working on your project, use the following commands:
45
46
 
46
47
  - \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies.
47
48
  Whenever you save changes, the data will be reprocessed.
49
+ - \`${runCommand} all-tests\` will run the project's test command.
48
50
  - \`${runCommand} clean\` will remove cache and temporary files, if present.
49
51
 
50
52
  Have fun!`,