@good-fences/api - npm Package Compare versions

Comparing version 0.16.0 to 0.17.0

.devcontainer/devcontainer.json

 {
   "$schema": "https://raw.githubusercontent.com/microsoft/vscode/master/extensions/configuration-editing/schemas/devContainer.schema.json",
-  "name": "good-fences-rs development container",
+  "name": "${localWorkspaceFolderBasename} devcontainer",
   "build": {
     "dockerfile": "./Dockerfile",
     "args": {
-      "USERNAME": "vscode"
+      "USERNAME": "ubuntu"
     }
   },
-  "remoteUser": "vscode",
+  // In wsl, we want the acting user to match the user we are launching Docker from,
+  // which is typically 'ubuntu' in the default WSL configuration.
+  //
+  // This is because mounted volumes from Linux retain their original file permissions.
+  // If the acting user is not the same as the user in the container, the container
+  // may not have permission to write to the mounted volume, or may mangle the permissions
+  // of mounted files.
+  //
+  // See https://github.com/microsoft/vscode-dev-containers/issues/108
+  "remoteUser": "ubuntu",
   // see https://github.com/microsoft/vscode-remote-release/issues/1333#issuecomment-528234042
-  "workspaceMount": "",
-  "runArgs": [
-    "--init",
-    "--volume=${localWorkspaceFolder}:/workspaces/ori:Z"
-  ],
   "settings": {
-    "terminal.integrated.shell.linux": "/bin/zsh"
+    "terminal.integrated.profiles.linux": {
+      "zsh": {
+        "path": "/usr/bin/zsh"
+      }
+    },
+    "terminal.integrated.defaultProfile.linux": "zsh"
   },
-  "workspaceFolder": "/workspaces/ori",
-  "postStartCommand": "/bin/bash .devcontainer/config_fetch.sh",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/${localWorkspaceFolderBasename},type=bind,consistency=delegated",
+  "mounts": [
+    // This mounts client-web checked out next to this repo for testing, left checked-in here for convenience.
+    // Don't commit it, though!
+    // "source=${localWorkspaceFolder}/../client-web,target=/workspaces/client-web,type=bind,consistency=cached",
+    // expose the user's ssh credentials to the dev container
+    "source=${localEnv:HOME}/.ssh,target=/home/ubuntu/.ssh,type=bind,consistency=cached",
+    // map the .persist directory to /cache so it can be persisted between container rebuilds.
+    // This persists zsh history as well as downloaded cargo crate sources.
+    "source=${localWorkspaceFolder}/.persist,target=/cache,type=bind,consistency=cached",
+    "source=${localWorkspaceFolder}/.persist/cargo-registry,target=/home/ubuntu/.cargo/registry,type=bind,consistency=cached"
+  ],
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+  // "postStartCommand": "/bin/bash .devcontainer/config_fetch.sh",
   "extensions": [
-    "rust-lang.rust-analyzer"
+    "ms-vscode.cpptools",
+    "rust-lang.rust-analyzer",
+    "tamasfe.even-better-toml",
+    "vadimcn.vscode-lldb"
   ],
   "remoteEnv": {
-    "VM_REPO_PATH": "/workspaces/ori"
+    "VM_REPO_PATH": "/workspaces/${localWorkspaceFolderBasename}"
   },
   "forwardPorts": [
     3000,
-    30001
+    3001
   ]
 }

.vscode/launch.json

@@ -20,5 +20,11 @@ {
             ],
-            "cwd": "${workspaceFolder}"
+            "cwd": "${workspaceFolder}",
+            "initCommands": [
+                "settings set target.disable-aslr false"
+            ],
+            "env": {
+                "RUST_BACKTRACE": "1"
+            }
         }
     ]
 }

CHANGELOG.json

@@ -5,3 +5,32 @@ {
     {
-      "date": "Tue, 20 Aug 2024 15:59:03 GMT",
+      "date": "Wed, 02 Oct 2024 18:13:38 GMT",
+      "version": "0.17.0",
+      "tag": "@good-fences/api_v0.17.0",
+      "comments": {
+        "patch": [
+          {
+            "author": "[e-mail]",
+            "package": "@good-fences/api",
+            "commit": "da4a089e6b6f33da5d04845c4f609b00bc3bfbc7",
+            "comment": "partial refactor of unused_finder to move parsing-related utilities to a submodule"
+          },
+          {
+            "author": "[e-mail]",
+            "package": "@good-fences/api",
+            "commit": "d561e55cb8bc1abd86addabf85a55ddeda534a65",
+            "comment": "extract packagejson from import_resolver"
+          }
+        ],
+        "minor": [
+          {
+            "author": "[e-mail]",
+            "package": "@good-fences/api",
+            "commit": "4e61efede5b51f6e2dc43de9662244794aca3bc5",
+            "comment": "Setup devcontainer, add 'exports' aware cacing resolver"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 20 Aug 2024 15:59:23 GMT",
       "version": "0.16.0",
@@ -8,0 +37,0 @@ "tag": "@good-fences/api_v0.16.0",

CHANGELOG.md

 # Change Log - @good-fences/api
 
-This log was last generated on Tue, 20 Aug 2024 15:59:03 GMT and should not be manually modified.
+This log was last generated on Wed, 02 Oct 2024 18:13:38 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.17.0
+
+Wed, 02 Oct 2024 18:13:38 GMT
+
+### Minor changes
+
+- Setup devcontainer, add 'exports' aware cacing resolver ([e-mail])
+
+### Patches
+
+- partial refactor of unused_finder to move parsing-related utilities to a submodule ([e-mail])
+- extract packagejson from import_resolver ([e-mail])
+
 ## 0.16.0
 
-Tue, 20 Aug 2024 15:59:03 GMT
+Tue, 20 Aug 2024 15:59:23 GMT
 
@@ -11,0 +24,0 @@ ### Minor changes

index.d.ts

@@ -8,3 +8,3 @@ /* tslint:disable */
   reportExportedItems: boolean
-  pathsToRead: Array<string>
+  rootPaths: Array<string>
   tsConfigPath: string
@@ -11,0 +11,0 @@ skippedDirs: Array<string>

package.json

 {
   "name": "@good-fences/api",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "main": "index.js",
@@ -47,7 +47,7 @@ "types": "index.d.ts",
   "optionalDependencies": {
-    "@good-fences/api-win32-x64-msvc": "0.16.0",
-    "@good-fences/api-darwin-x64": "0.16.0",
-    "@good-fences/api-linux-x64-gnu": "0.16.0",
-    "@good-fences/api-darwin-arm64": "0.16.0"
+    "@good-fences/api-win32-x64-msvc": "0.17.0",
+    "@good-fences/api-darwin-x64": "0.17.0",
+    "@good-fences/api-linux-x64-gnu": "0.17.0",
+    "@good-fences/api-darwin-arm64": "0.17.0"
   }
 }

README.md

@@ -127,3 +127,21 @@ # good-fences-rs-core
 
-
-
+# Development
+## Dev-Containers on WSL
+Development from windows happens in a devcontainer
+1. Install WSL2 (and restart your computer)
+    - `wsl --install` from any terminal window
+2. Install [Docker Engine](https://docs.docker.com/engine/install/) (and restart your computer)
+3. Install workspace recommended plugins (including the Dev Containers plugin)
+4. Build the container with `Ctrl+P > Dev Containers: Rebuild and Reopen in Container`
+    - If installation stalls on `docker inspect --type image ubuntu:24.10`, you may need to feth the base image manually
+    - Run `docker inspect --type image ubuntu:24.10`
+    - If it fails with `Error response from daemon: No such image: ubuntu`, then run `docker pull ubuntu:24.10`
+5. Develop in the container
+6. (optional) mount the workspace you are building against.
+   To test `unused-finder` against your repo during development, uncomment the commented-out "mount" in the checked-in `.devcontainer`: 
+   ```json5
+    // This mounts client-web checked out next to this repo for testing, left checked-in here for convenience.
+    // Don't commit it, though!
+    // "source=${localWorkspaceFolder}/../client-web,target=/workspaces/client-web,type=bind,consistency=cached",
+    ```
+    The provided example mounts `client-web` as a target repo

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

464242

increased by43.65%

Number of package files

128

increased by37.63%

Lines of code

1091

increased by9.21%

Number of lines in readme file

146

increased by13.18%

No dependency changes