Merge branch 'main' into path-expansion-improvement

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+ignore-words-list= afterall
+skip = .git,*.svg,package-lock.json,node_modules,*lotties*,nwb-guide.spec,prepare_pyinstaller_spec.py

.github/CODE_OF_CONDUCT.rst

@@ -0,0 +1,53 @@
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+----------
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+Our Responsibilities
+--------------------
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+Scope
+-----
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Request Format Support
+    url: https://github.com/catalystneuro/neuroconv/issues/new?assignees=&labels=enhancement%2Cdata+interfaces&projects=&template=format_request.yml&title=%5BNew+Format%5D%3A+
+    about: Request support for a new format on NeuroConv.
+  - name: NWB Community and Contact
+    url: https://www.nwb.org/contact-us/
+    about: Have a bunch of really specific questions? Just looking to learn more about NWB? Connect with the greater NWB community!
+  - name: NWB Best Practices
+    url: https://nwbinspector.readthedocs.io/en/dev/best_practices/best_practices_index.html
+    about: Check out the full list of Best Practices for making NWBFiles.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,58 @@
+name: Feature Request
+description: Suggest an idea for a brand new feature for the NWB GUIDE, or a change to an existing one.
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Thank you for your suggestion!
+
+        We welcome any ideas about how to make the **NWB GUIDE** better for the community.
+
+        Please keep in mind that new features may not get implemented immediately.
+  - type: textarea
+    id: summary
+    attributes:
+      label: What would you like to see added to the NWB GUIDE?
+      description: |
+        What are you trying to achieve with **NWB GUIDE**?
+
+        Is this a more convenient way to do something that is already possible, or is a workaround currently unfeasible?
+    validations:
+      required: true
+  - type: dropdown
+    id: interest
+    attributes:
+      label: Do you have any interest in helping implement the feature?
+      description: |
+        We appreciate any help you can offer!
+
+        For information on how to contribute, please refer to our [developer guide](https://nwb-guide.readthedocs.io/en/latest/developer_guide.html).
+      options:
+        - Yes.
+        - Yes, but I would need guidance.
+        - No.
+    validations:
+      required: true
+
+
+  - type: dropdown
+    id: code_of_conduct
+    attributes:
+      label: Code of Conduct
+      description: Do you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/.github/CODE_OF_CONDUCT.rst)?
+      options:
+        - "Yes"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: existing_issues
+    attributes:
+      label: Did you confirm this feature was not already reported?
+      description: This feature should not already be [reported](https://github.com/NeurodataWithoutBorders/nwb-guide/issues) in an existing issue
+      options:
+        - "Yes"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/report-issue.yml

@@ -0,0 +1,68 @@
+name: Report issue
+description: Let us know of any issue you encounter while using NWB GUIDE.
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # Thanks for taking the time to fill out this issue report!
+        ### The following information will help us resolve your issue.
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the issue
+      description: Provide a clear and concise description of what the issue is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: |
+        For example:
+          1. Go to '...'
+          2. Click on '....'
+          3. Scroll down to '....'
+          4. See error
+    validations:
+      required: true
+
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: Provide the operating system used to run the GUIDE (e.g. Windows 10 Pro)
+    validations:
+      required: true
+
+  - type: input
+    id: guide_version
+    attributes:
+      label: GUIDE Version
+      description: Provide the release version or development branch
+    validations:
+      required: true
+
+
+  - type: dropdown
+    id: code_of_conduct
+    attributes:
+      label: Code of Conduct
+      description: Do you agree to follow our [Code of Conduct](https://github.com/catalystneuro/tqdm_publisher/blob/main/.github/CODE_OF_CONDUCT.md)?
+      options:
+        - "Yes"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: existing_issues
+    attributes:
+      label: Did you confirm this issue was not already reported?
+      description: This issue should not already be [reported](https://github.com/NeurodataWithoutBorders/nwb-guide/issues)
+      options:
+        - "Yes"
+    validations:
+      required: true

.github/workflows/chromatic.yml

@@ -2,8 +2,8 @@ name: Chromatic
 
 on:
   workflow_dispatch:
-  #pull_request_review:
-  #  types: [submitted]
+  pull_request_review:
+    types: [submitted]
 
 jobs:
   test:

.github/workflows/codespell.yml

@@ -0,0 +1,19 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v1

prepare_pyinstaller_spec.py

@@ -40,4 +40,4 @@
 with open(file=Path(__file__).parent / "nwb-guide.spec", mode="w") as io:
     io.writelines(lines)
 
-print("Sucessfully injected recursion depth extension and json paths!")
+print("Successfully injected recursion depth extension and json paths!")

src/renderer/assets/css/global.css

@@ -12,7 +12,7 @@
     margin-top: 0px !important;
 }
 
-/*  Notfy */
+/*  Notyf */
 .notyf__toast {
     max-width: 40vw !important;
 }

src/renderer/assets/css/guided.css

@@ -1,6 +1,6 @@
 @import url("https://fonts.googleapis.com/css?family=Poppins:400,500,600,700");
 
-/* change the font to siblints of guided--body to Poppins except i elemenets */
+/* change the font to siblints of guided--body to Poppins except i elements */
 
 /*.guided--body *:not(i) {
   font-family: "Poppins", sans-serif;

src/renderer/src/stories/JSONSchemaInput.js

@@ -1090,7 +1090,7 @@ export class JSONSchemaInput extends LitElement {
 
                             if (schema.transform) newValue = schema.transform(newValue, this.value, schema);
 
-                            // // Do not check patter if value is empty
+                            // // Do not check pattern if value is empty
                             // if (schema.pattern && !isBlank) {
                             //     const regex = new RegExp(schema.pattern)
                             //     if (!regex.test(isNaN(newValue) ? value : newValue)) newValue = this.value // revert to last value

src/renderer/src/stories/pages/guided-mode/data/GuidedMetadata.js

@@ -228,7 +228,7 @@ export class GuidedMetadataPage extends ManagedPage {
 
             ignore: propsToIgnore,
             onOverride: (name) => {
-                this.notify(`<b>${header(name)}</b> has been overriden with a global value.`, "warning", 3000);
+                this.notify(`<b>${header(name)}</b> has been overridden with a global value.`, "warning", 3000);
             },
 
             transformErrors: (error) => {

src/renderer/src/stories/pages/guided-mode/data/GuidedSourceData.js

@@ -164,7 +164,7 @@ export class GuidedSourceDataPage extends ManagedPage {
             ignore: propsToIgnore,
             globals: this.info.globalState.project.SourceData,
             onOverride: (name) => {
-                this.notify(`<b>${header(name)}</b> has been overriden with a global value.`, "warning", 3000);
+                this.notify(`<b>${header(name)}</b> has been overridden with a global value.`, "warning", 3000);
             },
             // onlyRequired: true,
             onUpdate: () => (this.unsavedUpdates = "conversions"),

src/renderer/src/stories/pages/guided-mode/data/GuidedStructure.js

@@ -95,7 +95,7 @@ export class GuidedStructurePage extends Page {
             });
         }
 
-        await this.save(undefined, false); // Interrim save, in case the schema request fails
+        await this.save(undefined, false); // Interim save, in case the schema request fails
         await this.getSchema();
     };
 

src/renderer/src/stories/pages/guided-mode/options/GuidedUpload.js

@@ -105,7 +105,7 @@ export class GuidedUploadPage extends Page {
             if ("results" in globalUploadInfo) {
                 const result = await Swal.fire({
                     title: "This pipeline has already uploaded to DANDI",
-                    html: "Would you like to reupload the lastest files?",
+                    html: "Would you like to reupload the latest files?",
                     icon: "warning",
                     showCancelButton: true,
                     confirmButtonColor: "#3085d6",

src/renderer/src/stories/pages/guided-mode/setup/GuidedNewDatasetInfo.js

@@ -91,7 +91,7 @@ export class GuidedNewDatasetPage extends Page {
                 properties: ["createDirectory"],
             },
             onOverride: (name) => {
-                this.notify(`<b>${header(name)}</b> has been overriden with a global value.`, "warning", 3000);
+                this.notify(`<b>${header(name)}</b> has been overridden with a global value.`, "warning", 3000);
             },
             validateOnChange,
             onUpdate: () => (this.unsavedUpdates = true),

src/renderer/src/stories/pages/guided-mode/setup/GuidedSubjects.js

@@ -131,7 +131,7 @@ export class GuidedSubjectsPage extends Page {
             },
             onThrow: (message, type) => this.notify(message, type),
             onOverride: (name) => {
-                this.notify(`<b>${header(name)}</b> has been overriden with a global value.`, "warning", 3000);
+                this.notify(`<b>${header(name)}</b> has been overridden with a global value.`, "warning", 3000);
             },
             onUpdate: () => {
                 console.log("UPDATED!");

src/renderer/src/stories/preview/inspector/InspectorList.js

@@ -14,10 +14,10 @@ const sortList = (items) => {
             else return 1;
         })
         .sort((a, b) => {
-            const aLow = a.severity == "LOW";
-            const bLow = b.severity === "LOW";
-            if (aLow && bLow) return 0;
-            else if (aLow) return 1;
+            const lowA = a.severity == "LOW";
+            const lowB = b.severity === "LOW";
+            if (lowA && lowB) return 0;
+            else if (lowA) return 1;
             else return -1;
         });
 };