Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to top-level layout #3

Merged
merged 5 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: Codespell

on:
push:
branches: [master]
branches: [master, main]
pull_request:
branches: [master]
branches: [master, main]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -21,4 +21,4 @@ jobs:
- uses: codespell-project/actions-codespell@master
with:
ignore_words_list: ro,anser,te,tage,afterall,nwe,nin,nd,falsy
skip: package-lock.json, deps*, deno.lock
skip: deno.lock
4 changes: 2 additions & 2 deletions .github/workflows/deno_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name: Deno build

on:
push:
branches: [master]
branches: [master, main]
tags: ['*']
pull_request:
branches: [master]
branches: [master, main]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/schema_web_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name: Schema validator web build

on:
push:
branches: [master]
branches: [master, main]
tags: ['*']
pull_request:
branches: [master]
branches: [master, main]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "bids-examples"]
path = bids-validator/tests/data/bids-examples
path = tests/data/bids-examples
url = https://github.com/bids-standard/bids-examples.git
17 changes: 4 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To participate, be sure you know how to
1. [Make a GitHub account][link_signupinstructions]
1. Install the required software:
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [NodeJS](https://nodejs.org/en/download/), including `npm` of version 7 or higher (check existing version with `npm -v`, to update an existing nodejs, we can suggest [this guide](https://phoenixnap.com/kb/update-node-js-version).)
- [Deno](https://deno.com/)
1. In the GitHub interface, [make a fork][link_fork] of
https://github.com/bids-standard/bids-validator to your own user (called `USER` for the
sake of the example)
Expand All @@ -71,18 +71,9 @@ To participate, be sure you know how to
- You will now have a new directory called `bids-validator`
- navigate to that directory and run `git status` to verify that it's a `git`
directory
- run `npm install` to install the BIDS validator
1. Upon inspection of the `bids-validator` repository we can find the
"executable" BIDS validator, located in `<...>/bids-validator/bin`, where
`<...>` is the path to your `bids-validator` repository
- To make this executable available from the command line, we have to add it
to the path. On Unix systems with bash as their default shell, this means
editing the `.bashrc` file by adding the following line to the bottom of
it: `export PATH="$PATH:<...>/bids-validator/bin"` ... Note that `<...>`
again needs to be replaced by the path to your BIDS validator repository
- Now whenever you open a new command line, we will have the `bids-validator`
executable available. You can verify by opening a new command line and
typing `bids-validator --version`, and it should print the version number
1. Install `bids-validator` with: `deno install -Agf --reload ./bids-validator/src/bids-validator.ts`
- Deno will install the file to its `bin` directory. On Unix systems,
this should be `$HOME/.deno/bin`. You may need to add this to your `PATH`.

Now your development version of BIDS validator is set up and you can use it.
Whenever you _checkout_ a new branch in your git repository, the
Expand Down
449 changes: 41 additions & 408 deletions README.md

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion bids-validator/.gitattributes

This file was deleted.

1 change: 0 additions & 1 deletion bids-validator/.npmignore

This file was deleted.

71 changes: 0 additions & 71 deletions bids-validator/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions bids-validator/bids-validator-deno

This file was deleted.

57 changes: 0 additions & 57 deletions bids-validator/deno.json

This file was deleted.

File renamed without changes.
56 changes: 55 additions & 1 deletion deno.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,57 @@
{
"lock": false
"name": "@bids/validator",
"version": "1.14.14",
"exports": {
".": "./src/bids-validator.ts",
"./main": "./src/main.ts",
"./output": "./src/utils/output.ts",
"./files": "./src/files/deno.ts",
"./options": "./src/setup/options.ts",
"./issues": "./src/issues/datasetIssues.ts"
},
"publish": {
"exclude": [
"bids_validator/",
"bin/",
"tests/",
"docs/",
"utils/",
"validators/",
"bids-validator-deno",
"build.ts",
"cli.js",
"esbuild.mjs",
"index.js",
"package.json",
".npmignore",
".gitattributes"
]
},
"imports": {
"@ajv": "npm:[email protected]",
"@bids/schema": "jsr:@bids/[email protected]+6e2874ce",
"@cliffy/command": "jsr:@cliffy/[email protected]",
"@cliffy/table": "jsr:@cliffy/[email protected]",
"@hed/validator": "npm:[email protected]",
"@ignore": "npm:[email protected]",
"@libs/xml": "jsr:@libs/[email protected]",
"@mango/nifti": "npm:@bids/[email protected]",
"@std/assert": "jsr:@std/[email protected]",
"@std/fmt": "jsr:@std/[email protected]",
"@std/fs": "jsr:@std/[email protected]",
"@std/io": "jsr:@std/[email protected]",
"@std/log": "jsr:@std/[email protected]",
"@std/path": "jsr:@std/[email protected]",
"@std/yaml": "jsr:@std/yaml@^1.0.4"
},
"tasks": {
"test": "deno test -A src/tests/"
},
"fmt": {
"lineWidth": 99,
"semiColons": false,
"singleQuote": true,
"proseWrap": "preserve",
"include": ["src/"]
}
}
File renamed without changes.
4 changes: 4 additions & 0 deletions local-run
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env -S deno run --allow-read --allow-write --allow-env --allow-net --allow-run
// This script runs the local copy of the validator, intended as a development aid.
// You generally should run `deno run -A jsr:@bids/validator`
import './src/bids-validator.ts'
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Loading