Skip to content

Commit

Permalink
Fix broken links to types file (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
rolfheij-sil authored Sep 27, 2023
2 parents 4fbc12c + 1c1d76f commit bb64d70
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is a webpack project template pre-configured to build Paranext extensions.
- `package.json` contains information about this extension's npm package. It is required for Paranext to use the extension properly. It is copied into the build folder
- `src` contains the source code for the extension
- `src/main.ts` is the main entry file for the extension
- `src/types/extension-types.d.ts` is this extension's types file that defines how other extensions can use this extension through the `papi`. It is copied into the build folder
- `src/types/paranext-extension-template.d.ts` is this extension's types file that defines how other extensions can use this extension through the `papi`. It is copied into the build folder
- `*.web-view.tsx` files will be treated as React WebViews
- `*.web-view.html` files are a conventional way to provide HTML WebViews (no special functionality)
- `public` contains static files that are copied into the build folder
Expand Down
23 changes: 0 additions & 23 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"version": "0.0.1",
"main": "paranext-extension-template.js",
"types": "extension-types.d.ts",
"types": "paranext-extension-template.d.ts",
"author": "Paranext",
"license": "MIT",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion webpack/webpack.config.main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ const configMain: webpack.Configuration = merge(configBase, {
// We want all files from the public folder copied into the output folder
{ from: 'public', to: './' },
// Copy this extension's type declaration file into the output folder
{ from: 'src/types/extension-types.d.ts', to: './' },
{ from: 'src/types/paranext-extension-template.d.ts', to: './' },
// We need to distribute the package.json for Paranext to read the extension properly
{ from: 'package.json', to: './' },
],
Expand Down

0 comments on commit bb64d70

Please sign in to comment.