Squashed 'src/paratext-bible-word-list/' changes from 01213e7..c9ab690

c9ab690 update dependencies (#83)
d5cec09 Moved LIBRARY_TYPE to match multi template (#82)
43898cb Moved LIBRARY_TYPE to match multi template
94c18cb Added tailwind to extension template (#81)
5bce9e0 Updated sass
33d69a3 Fixed template info comment not closing properly
a3351bb Added tailwind to extension template
8bc6203 update dependencies (#80)
0dbceff Clarify readme uncommenting directions (#79)
682f7ea Clarify readme uncommenting directions
fce0644 Bump webpack from 5.91.0 to 5.94.0 (#78)
ccbc2d1 Removed outdated change description line, add comment template info section and instructions to avoid merge conflicts (#77)
0179014 Removed outdated change description line, add comment template info section and instructions to avoid merge conflicts
8d7fc6f #481: Changed a couple places in files where we descriptions that refer to Paranext (#75)

git-subtree-dir: src/paratext-bible-word-list
git-subtree-split: c9ab69053688b482adba4d77144f5cf2b5ff0a3d

.stylelintrc.js

@@ -1,7 +1,11 @@
 // #region shared with https://github.com/paranext/paranext-core/blob/main/.stylelintrc.js and https://github.com/paranext/paranext-multi-extension-template/blob/main/.stylelintrc.cjs
 
 module.exports = {
-  extends: ['stylelint-config-recommended', 'stylelint-config-sass-guidelines'],
+  extends: [
+    'stylelint-config-recommended',
+    'stylelint-config-sass-guidelines',
+    'stylelint-config-tailwindcss/scss',
+  ],
   overrides: [
     {
       files: ['**/*.scss'],

.vscode/settings.json

@@ -1,4 +1,6 @@
 {
+  "css.customData": [".vscode/tailwindcss.json"],
+
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.rulers": [100],

.vscode/tailwindcss.json

@@ -0,0 +1,56 @@
+{
+  "version": 1.1,
+  "credit": "https://duncanleung.com/tailwind-css-unknown-at-rule/",
+  "atDirectives": [
+    {
+      "name": "@tailwind",
+      "description": "Use the `@tailwind` directive to insert Tailwind's `base`, `components`, `utilities` and `screens` styles into your CSS.",
+      "references": [
+        {
+          "name": "Tailwind Documentation",
+          "url": "https://tailwindcss.com/docs/functions-and-directives#tailwind"
+        }
+      ]
+    },
+    {
+      "name": "@apply",
+      "description": "Use the `@apply` directive to inline any existing utility classes into your own custom CSS. This is useful when you find a common utility pattern in your HTML that you’d like to extract to a new component.",
+      "references": [
+        {
+          "name": "Tailwind Documentation",
+          "url": "https://tailwindcss.com/docs/functions-and-directives#apply"
+        }
+      ]
+    },
+    {
+      "name": "@responsive",
+      "description": "You can generate responsive variants of your own classes by wrapping their definitions in the `@responsive` directive:\n```css\n@responsive {\n  .alert {\n    background-color: #E53E3E;\n  }\n}\n```\n",
+      "references": [
+        {
+          "name": "Tailwind Documentation",
+          "url": "https://tailwindcss.com/docs/functions-and-directives#responsive"
+        }
+      ]
+    },
+    {
+      "name": "@screen",
+      "description": "The `@screen` directive allows you to create media queries that reference your breakpoints by **name** instead of duplicating their values in your own CSS:\n```css\n@screen sm {\n  /* ... */\n}\n```\n…gets transformed into this:\n```css\n@media (min-width: 640px) {\n  /* ... */\n}\n```\n",
+      "references": [
+        {
+          "name": "Tailwind Documentation",
+          "url": "https://tailwindcss.com/docs/functions-and-directives#screen"
+        }
+      ]
+    },
+    {
+      "name": "@variants",
+      "description": "Generate `hover`, `focus`, `active` and other **variants** of your own utilities by wrapping their definitions in the `@variants` directive:\n```css\n@variants hover, focus {\n   .btn-brand {\n    background-color: #3182CE;\n  }\n}\n```\n",
+      "references": [
+        {
+          "name": "Tailwind Documentation",
+          "url": "https://tailwindcss.com/docs/functions-and-directives#variants"
+        }
+      ]
+    }
+  ]
+}

README.md

@@ -2,6 +2,8 @@
 
 Basic extension template for Platform.Bible
 
+<!-- <!-- Opening comment tag for Template Info Section. Ignore this for now. More info in [Hide Template Info](#hide-template-info). -->
+
 ## Template Info
 
 This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs. Note that the `*.web-view.*` files and the `public/assets` folder mentioned in [Summary](#summary) are not present in this template. For inspiration on what these could look like, refer to any extension that is built using this template. An example would be the [Text Collection extension](https://github.com/paranext/paranext-extension-text-collection).
@@ -32,13 +34,11 @@ To make the process of customizing from the template as smooth as possible, we r
 - In `manifest.json`:
 
   - Replace `paranext-extension-template` with `your-extension-name` (2 occurrences)
-  - Replace the description with your own description
   - Update ownership information and other relevant fields as desired
 
 - In `package.json`:
 
   - Replace `paranext-extension-template` with `your-extension-name` (2 occurrences)
-  - Replace the description with your own description
   - Update ownership information and other relevant fields as desired
 
 - In `assets/displayData.json`:
@@ -69,9 +69,13 @@ To make the process of customizing from the template as smooth as possible, we r
 
 The `manifest.json` and `package.json` files contain information specific to your extension. Add your extension's details in these two files as needed. See more information on the `manifest.json` and `package.json` files in [Extension Anatomy](https://github.com/paranext/paranext-extension-template/wiki/Extension-Anatomy#extension-manifest).
 
-#### Remove Template Info
+#### Hide Template Info
+
+Once finished customizing this template to be your own, you can uncomment the [HTML comment tag](https://www.w3schools.com/html/html_comments.asp) above the [Template Info](#template-info) section to hide this template-related info in this readme. You can do this by clicking on the line and doing CTRL + / in VS Code. You can also do this manually by removing the first opening '&lt;!--' and the only closing '--&gt;' on the line. Leaving this info commented in your readme will hide it in your readme while avoiding merge conflicts if you decide to [update this extension from the template](#to-update-this-extension-from-the-template) in the future. If you never want to update this extension from the template, you can remove the [Template Info](#template-info) section and sub-sections of this readme.
+
+Note: if you [update this extension from the template](#to-update-this-extension-from-the-template), there may be important changes in this section like additional customizations you must make to this extension. Please keep an eye out for readme changes when updating from the template.
 
-Once finished customizing this template to be your own, you can remove the [Template Info](#template-info) section and sub-sections of this readme.
+<!-- Closing comment tag for Template Info Section -->
 
 ## Summary
 

assets/descriptions/description-en.md

@@ -1,3 +1,3 @@
-Extension template for Paranext. Powered by webpack.
+Extension template for Platform.Bible. Powered by webpack.
 
-This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs.
+This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs.

assets/displayData.json

@@ -5,7 +5,7 @@
   "localizedDisplayInfo": {
     "en": {
       "displayName": "Paranext Extension Template",
-      "shortSummary": "Base template for a Paranext Extension",
+      "shortSummary": "Base template for a Platform.Bible Extension",
       "description": "assets/descriptions/description-en.md"
     }
   }