Skip to content

Commit

Permalink
Package for ESM and CJS
Browse files Browse the repository at this point in the history
  • Loading branch information
irahopkinson committed Jun 30, 2023
1 parent 0a4b456 commit 59cbb54
Show file tree
Hide file tree
Showing 14 changed files with 769 additions and 34 deletions.
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
lib
dist
coverage
4 changes: 4 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ module.exports = {
'plugin:@typescript-eslint/strict',
'prettier',
],
env: {
browser: true,
node: true,
},
rules: {
'@typescript-eslint/no-unused-vars': [
'warn',
Expand Down
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# compliled output
/lib
*.tgz

# Logs
logs
*.log
Expand Down
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
lib
dist
coverage
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License
Copyright (c) SIL International.

Copyright (c) 2023- SIL International
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# scripture

TypeScript partial port of [libpalaso/SIL.Scripture][github-libpalaso-scripture].

<div align="center">

[![Build Status][github-actions-status]][github-actions-url]
Expand All @@ -10,6 +8,15 @@ TypeScript partial port of [libpalaso/SIL.Scripture][github-libpalaso-scripture]

</div>

TypeScript partial port of C# library [libpalaso/SIL.Scripture][github-libpalaso-scripture]. These libraries are used by [Paratext](https://paratext.org/) to represent Scripture.

## Features

- {class} Canon - Canon information. Also, contains static information on complete list of books.
- {class} VerseRef - Stores a reference to a specific verse in Scripture.
- Represents single references and ranges, such as: GEN 2:3, LUK 3:4b-5a
- Supports versification types: Unknown, Original, Septuagint, Vulgate, English, RussianProtestant, RussianOrthodox.

## Installation

```sh
Expand Down
11 changes: 11 additions & 0 deletions dts-bundle-generator.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
const config = {
entries: [
{
filePath: './src/index.ts',
outFile: './dist/index.d.ts',
noCheck: false,
},
],
};

module.exports = config;
Loading

0 comments on commit 59cbb54

Please sign in to comment.