spec-up-t 1.1.52 → 1.1.53

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 (21) hide show
  1. package/assets/js/insert-trefs.js +1 -1
  2. package/branches.md +33 -0
  3. package/package.json +7 -1
  4. package/src/README.md +98 -0
  5. package/src/collect-external-references.js +108 -31
  6. package/src/collect-external-references.test.js +152 -0
  7. package/src/collectExternalReferences/fetchTermsFromGitHubRepository.js +39 -44
  8. package/src/collectExternalReferences/fetchTermsFromGitHubRepository.test.js +385 -0
  9. package/src/collectExternalReferences/matchTerm.js +10 -5
  10. package/src/collectExternalReferences/matchTerm.test.js +30 -0
  11. package/src/collectExternalReferences/octokitClient.js +96 -0
  12. package/src/collectExternalReferences/processXTrefsData.js +2 -0
  13. package/src/create-term-index.js +3 -1
  14. package/src/create-term-relations.js +3 -1
  15. package/src/fix-markdown-files.js +2 -1
  16. package/src/prepare-tref.js +2 -1
  17. package/src/utils/file-filter.js +36 -0
  18. package/src/utils/isLineWithDefinition.js +5 -10
  19. package/readme.md +0 -10
  20. package/src/collectExternalReferences/checkRateLimit.js +0 -17
  21. package/src/collectExternalReferences/setupFetchHeaders.js +0 -14
package/readme.md DELETED
@@ -1,10 +0,0 @@
1
- # Spec-Up-T
2
-
3
- <div align="center">
4
-
5
- <img src="./static/specup_logo.png">
6
-
7
- <h2 style="display: block; margin: 0 auto; text-align: center;">Markdown » Spec-Up</h2>
8
- </div>
9
-
10
- There is a [special website that documents everything regarding Spec-Up-T](https://blockchainbird.github.io/spec-up-t-website/).
package/src/collectExternalReferences/checkRateLimit.js DELETED
@@ -1,17 +0,0 @@
1
- // Function to check the rate limit of the GitHub API
2
- function checkRateLimit(response) {
3
- const remaining = response.headers.get('X-RateLimit-Remaining');
4
- const reset = response.headers.get('X-RateLimit-Reset');
5
-
6
- if (response.status === 403 && remaining === '0') {
7
- const resetTime = new Date(reset * 1000);
8
- console.error(`❌ Github API rate limit exceeded. Try again after ${resetTime}. See https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token for more info.`);
9
- return true;
10
- } else if (remaining !== null) {
11
- console.log(`ℹ️ Github API rate limit: ${remaining} requests remaining. See https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token for more info.`);
12
- } else {
13
- console.warn(`ℹ️ Unable to determine rate limit status. Check your GitHub API token and network connection.`);
14
- }
15
- return false;
16
- }
17
- exports.checkRateLimit = checkRateLimit;
package/src/collectExternalReferences/setupFetchHeaders.js DELETED
@@ -1,14 +0,0 @@
1
- function setupFetchHeaders(GITHUB_API_TOKEN) {
2
- const fetchHeaders = {
3
- 'Accept': 'application/vnd.github.v3+json'
4
- };
5
-
6
- if (GITHUB_API_TOKEN) {
7
- fetchHeaders['Authorization'] = `token ${GITHUB_API_TOKEN}`;
8
- } else {
9
- console.log('ℹ️ There is no GitHub token set up. Therefore, you are more likely to be at your limit of GitHub API requests. If you run into the limit, create a token and search the documentation on this topic.');
10
- }
11
-
12
- return fetchHeaders;
13
- }
14
- exports.setupFetchHeaders = setupFetchHeaders;