tsv-groupdata-parser

v0.9.17

Parses the translationNotes TSVs files to generate the GroupIndex and GroupData for the translationCore Desktop app.

NPM

README

GitHub

Website

ISC

Latest version published 7 months ago

    npm install tsv-groupdata-parser

We couldn't find any similar packages Browse all packages

Package Health Score

59 / 100

Popularity
Limited
Maintenance
Sustainable
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (20)

Dependents: 1
GitHub Stars: 0
Forks: 0
Contributors: 5

The npm package tsv-groupdata-parser receives a total of 20 downloads a week. As such, we scored tsv-groupdata-parser popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package tsv-groupdata-parser, we found that it has been starred ? times, and that 1 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.5.1

0.6.3

0.7.2

0.8.5

0.9.17

Indirect Vulnerabilities

0.5.1

0.6.3

0.7.2

0.8.5

0.9.17

License Risks

0.5.1

0.6.3

0.7.2

0.8.5

0.9.17

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like tsv-groupdata-parser is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test tsv-groupdata-parser

Fix it in your project with Snyk!

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Merged PR: 32
Open PR: 0
Last Commit: 3 months ago

Further analysis of the maintenance status of tsv-groupdata-parser based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that tsv-groupdata-parser demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No
License: ISC

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like tsv-groupdata-parser is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 5 Direct / 10 Total
Versions: 58
Install Size: 146 kB
Dist-tags: 3
# of Files: 38
Maintainers: 12
TS Typings: No

We detected a total of 10 direct & transitive dependencies for tsv-groupdata-parser. See the full dependency tree of tsv-groupdata-parser

tsv-groupdata-parser has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

tsv-groupdata-parser

Parses the translationNotes TSV files to generate the GroupsIndex and GroupsData for the translationCore Desktop app.

Usage

  import {
    tsvToGroupData,
    categorizeGroupData,
    formatAndSaveGroupData
  } from 'tsv-groupdata-parser';

  // tsvToGroupData() example
  const filepath = '__tests__/fixtures/tsv/en_tn_57-TIT.tsv';
  const originalBiblePath = '__tests__/fixtures/resources/el-x-koine/bibles/ugnt/v0.11';

  tsvToGroupData(filepath, "translationNotes", null, originalBiblePath).then((data) => {
    const groupData = data;
  });

  // Or with async/await
  const groupData = await tsvToGroupData(filepath, "translationNotes", null, originalBiblePath);

  // tsvToGroupData() example with categorized group data.
  const categorizedGroupData = await tsvToGroupData(filepath, "translationNotes", { categorized: true }, originalBiblePath);

  // categorizeGroupData() example
  const categorizedGroupData = categorizeGroupData(groupData)
  const rootOutputPath = 'translationCore/resources/en/thelps/tNotes'

  // formatAndSaveGroupData() example
  formatAndSaveGroupData(categorizedGroupData, rootOutputPath, 'tit')

Testing your changes without publishing new version

Create your feature/bugfix/enhancement (my-feature-branch)branch off of master.
Make your changes in the new branch (my-feature-branch).
Push your changes.
Run npm i unfoldingWord/tsv-groupdata-parser#my-feature-branch in your translationCore root directory.
For subsequent changes run rm -rf node_modules/tsv-groupdata-parser; npm i tsv-groupdata-parser;

Builds

Builds are made using babel 7 (babel-cli) for more infor see: Babel CLI docs