Merge pull request #1226 from posit-dev/dotnomad/format-repo

.github/ISSUE_TEMPLATE/issue-template.md

@@ -1,17 +1,16 @@
 ---
 name: Issue Template
 about: An issue template.
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 Description for the issue.
 
 ### Related Issues
 
-- 
+-
 
 ```[tasklist]
 ### Acceptance Criteria

.github/pull_request_template.md

@@ -2,34 +2,41 @@
 <!-- Examples: Updates pull request template -->
 
 ## Intent
+
 <!-- Describe what problem you are addressing in this pull request. -->
 <!-- If this change is associated with an open issue, please link to it here. -->
 <!-- Example: "Resolves #24" -->
 <!-- See https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue -->
 
 ## Type of Change
+
 <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
 <!-- If you check more than one box, you may need to refactor this change into separate pull requests -->
 
-* - [ ] Bug Fix           <!-- A change which fixes an existing issue -->
-* - [ ] New Feature       <!-- A change which adds additional functionality -->
-* - [ ] Breaking Change   <!-- A breaking change which causes existing functionality to change -->
-* - [ ] Documentation     <!-- User or developer documentation -->
-* - [ ] Refactor          <!-- Code restructuring -->
-* - [ ] Tooling           <!-- Build, CI, or release scripts and configuration -->
+- - [ ] Bug Fix <!-- A change which fixes an existing issue -->
+- - [ ] New Feature <!-- A change which adds additional functionality -->
+- - [ ] Breaking Change <!-- A breaking change which causes existing functionality to change -->
+- - [ ] Documentation <!-- User or developer documentation -->
+- - [ ] Refactor <!-- Code restructuring -->
+- - [ ] Tooling <!-- Build, CI, or release scripts and configuration -->
 
 ## Approach
+
 <!-- Describe how you solved this problem and any trade-offs you encountered. -->
 <!-- Link any additional documentation associated with this change here -->
 
 ## Automated Tests
+
 <!-- Describe the automated tests associated with this change. -->
 <!-- If automated tests are not included in this change, please state why. -->
 
 ## Directions for Reviewers
+
 <!-- Provide steps for reviewers to validate this change manually. -->
 
 ## Checklist
+
 <!--- Go over all the following points, and put an `x` in all the boxes that apply: -->
 <!--- If you need clarification on any of these, feel free to ask. We're here to help! -->
+
 - [ ] I have updated [CHANGELOG.md](../CHANGELOG.md) to cover notable changes.

.github/workflows/bats.yaml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           repository: rstudio/connect-content
-          path: 'test/content'
+          path: "test/content"
           sparse-checkout: bundles
           sparse-checkout-cone-mode: false
           token: ${{ secrets.CONNECT_PAT }}
@@ -56,7 +56,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           repository: rstudio/connect-content
-          path: 'test/content'
+          path: "test/content"
           sparse-checkout: bundles
           sparse-checkout-cone-mode: false
           token: ${{ secrets.CONNECT_PAT }}

.github/workflows/contract.yaml

@@ -35,7 +35,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           repository: rstudio/connect-content
-          path: 'test/content'
+          path: "test/content"
           sparse-checkout: bundles
           sparse-checkout-cone-mode: false
           token: ${{ secrets.CONNECT_PAT }}

.github/workflows/lint.yaml

@@ -6,21 +6,21 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: extractions/setup-just@v2
-    - uses: actions/setup-node@v4
-      with:
-        node-version: '20'
-        cache: 'npm'
-        cache-dependency-path: '**/package-lock.json'
-    - run: just npm-install
-    - run: just check-format
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v2
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          cache-dependency-path: "**/package-lock.json"
+      - run: just npm-install
+      - run: just check-format
 
-    - run: just vscode deps
-    - run: just vscode lint
+      - run: just vscode deps
+      - run: just vscode lint
 
-    - run: just web install
-    - run: just web lint
+      - run: just web install
+      - run: just web lint
 
-    - run: just test/cy install
-    - run: just test/cy lint
+      - run: just test/cy install
+      - run: just test/cy lint

.github/workflows/nightly.yaml

@@ -33,7 +33,7 @@ jobs:
       - archive
       - package
     uses: ./.github/workflows/upload.yaml
-    with: 
+    with:
       nightly: true
     secrets: inherit
 

.github/workflows/ui.yaml

@@ -23,7 +23,6 @@ jobs:
       - run: just cy install
       - run: just cy test
 
-
       # Videos are captured whether the suite fails or passes
       - name: Save videos
         uses: actions/upload-artifact@v4

.github/workflows/upload.yaml

@@ -1,15 +1,15 @@
 name: Upload
 on:
   workflow_call:
-    inputs: 
-      nightly: 
-        description: 'Is this a nightly upload?'
+    inputs:
+      nightly:
+        description: "Is this a nightly upload?"
         required: false
         default: false
         type: boolean
 permissions:
   id-token: write # This is required for requesting the JWT
-  contents: read  # This is required for actions/checkout
+  contents: read # This is required for actions/checkout
 jobs:
   upload:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -25,25 +25,30 @@ Deployment Records and Configurations can now be created, opened, and in the
 case of Configurations edited directly via the Extension's views.
 
 ### Added
+
 - Include links to documentation and feedback channel (#1140)
 - Add comments to deployment records indicating they should not editted by users (#1092)
 - Deployment staged logs view in the bottom VSCode panel
 - Ability to select a Configuration when deploying
 
 ### Changed
+
 - Use relative paths for the configuration `entrypoint` for Quarto projects (#960)
 
 ### Fixed
+
 - Fix being unable to ignore subdirectories in `.positignore` (#1117)
 - Improve error serialization with errors from Connect or networking (#1074)
 - Fixed cases where an unnamed `.toml` deployment record was created (#1076, #1113)
 
 ### Removed
+
 - Stand-alone webview opened via an Editor button on files
 
 ## [1.0.alpha2]
 
 ### Added
+
 - VSCode extension package includes the publisher binary (#737)
 - `publisher init` recognizes Quarto projects (jupyter and markdown engines only) (#814)
 - `publisher init` recognizes Bottle and Pycnic apps as WSGI/Flask variants (#794)
@@ -53,19 +58,22 @@ case of Configurations edited directly via the Extension's views.
 - Deployment history includes the URLs where the deployed content can be accessed (#742), error information if the deployment failed (#747), and the date/time the deployment was created (#639, #836, #839)
 
 ### Changed
+
 - Require the user to choose an account, if they have more than one (#636)
 - Use CONNECT_SERVER and CONNECT_API_KEY environment variables if they are defined and no account is selected (#722)
 - Deployment names in the UI are now case-insensitive (#808)
 - Record new deployments immediately, instead of waiting until Deploy is clicked (#773, #775, #776, #777)
 
 ### Fixed
+
 - Improve UI navigation, especially when going back or viewing progress/logs (#788, #824)
 - Enable copy/paste in the VSCode publisher window (#612)
 - Enable command palette in the VSCode publisher window (#633)
 - Enable clickable links in the VSCode publisher window (#589, #609, #759)
 - Improve messages for TOML parsing/validation errors (#631)
 
 ### Removed
+
 - Light/dark mode selection menu when running in VSCode (#804)
 
 ## [1.0.alpha1]

CONTRIBUTING.md

@@ -25,7 +25,6 @@
     - [Pre-Releases](#pre-releases)
     - [Release Lifecycle](#release-lifecycle)
 
-
 The get this project up and running on your local machine, execute the following Just commands:
 
 ```console
@@ -74,7 +73,7 @@ just run
 
 ## Testing
 
-This project follows the guidance written by *Ham Vocke* in the *[The Practical Test Pyramid](https://martinfowler.com/articles/practical-test-pyramid.html).* Please read the article for a detailed overview of different test types and how they are utilized.
+This project follows the guidance written by _Ham Vocke_ in the _[The Practical Test Pyramid](https://martinfowler.com/articles/practical-test-pyramid.html)._ Please read the article for a detailed overview of different test types and how they are utilized.
 
 ### Unit Tests
 
@@ -122,13 +121,12 @@ Execute `just -l` for a list of available commands and documentation.
 
 When executing commands the following variables are accepted to change behavior.
 
-| Variable | Default | Type | Description                                                                                              |
-|----------|---------|------|----------------------------------------------------------------------------------------------------------|
-| CI       | false   | bool | Enable CI mode.   When set to true, multi-platform builds are enabled.                                   |
-| DEBUG    | false   | bool | Enable DEBUG mode.   When set to true, `set +x` is enabled for all Justfile targets.                     |
-| DOCKER   | false   | bool | Enable DOCKER mode.  When set to true, all Justfile targets are executed in Docker.                      |
-| MODE     | dev     | enum | When set to `dev`, development is enabled. All other values disable development mode.                    |
-
+| Variable | Default | Type | Description                                                                           |
+| -------- | ------- | ---- | ------------------------------------------------------------------------------------- |
+| CI       | false   | bool | Enable CI mode. When set to true, multi-platform builds are enabled.                  |
+| DEBUG    | false   | bool | Enable DEBUG mode. When set to true, `set +x` is enabled for all Justfile targets.    |
+| DOCKER   | false   | bool | Enable DOCKER mode. When set to true, all Justfile targets are executed in Docker.    |
+| MODE     | dev     | enum | When set to `dev`, development is enabled. All other values disable development mode. |
 
 #### Behavior in GitHub Actions
 
@@ -137,7 +135,7 @@ When running in GitHub Actions, the env variable `CI` is set to `true` by GitHub
 This mode can be reproduced on your local machine by setting `CI=true`.
 
 | Variable | Default |
-|----------|---------|
+| -------- | ------- |
 | DOCKER   | true    |
 | MODE     | prod    |
 
@@ -155,7 +153,6 @@ To start a release create a semver compatible tag.
 
 _For this example, we will use the tag `v0.0.dev0`. This tag already exists, so you will not be able run the following commands verbatim._
 
-
 **Step 1**
 
 Create a proper SemVer compatible tag. Consult the [SemVer specification](https://semver.org/spec/v2.0.0.html) if you are unsure what this means.
@@ -209,7 +206,6 @@ An beta pre-release. Created to support closed external user testing. `N` starts
 
 *https://peps.python.org/pep-0440/#pre-releases*
 
-
 **`X.Y.rcN`**
 
 An release-candidate pre-release. Created to support open external user testing. `N` starts at **1** and increments by 1 (`X.Y.rc1`, `X.Y.rc2`, ..., `X.Y.rcN`).

build/docker-compose.yml

@@ -1,4 +1,4 @@
-version: '3'
+version: "3"
 
 services:
   connect:

docs/cli.md

@@ -23,7 +23,7 @@ The client auto-detects the type of content in `DIRECTORY`.
 
 For Python apps, `publisher` looks for a single Python source file in the
 directory to be the entrypoint. If there are multiple python files, one of them
-must be named `app.py`, `api.py`, `main.py`, or  `streamlit_app.py`.
+must be named `app.py`, `api.py`, `main.py`, or `streamlit_app.py`.
 
 For Quarto projects, `publisher` looks for a .qmd file with the same name as the
 project directory, or for a single .qmd file to be the entrypoint.
@@ -60,7 +60,6 @@ creates a record of the deployment in `.posit/publish/deployments/${NAME}.toml`
 ([schema](https://cdn.posit.co/publisher/schemas/posit-publishing-record-schema-v3.json)).
 `DIRECTORY` is optional, and defaults to the current directory.
 
-
 It is OK to rename deployment files as long as they live in
 `.posit/publish/deployments` and have a `.toml` suffix. Deleting a deployment
 file is also OK, and will cause `publisher` to forget about that deployment.