Merge pull request #1835 from nodeSolidServer/esm2

- convert NSS from CJS to ESM
- eslint@9
- oidc
  - add scope WebID
  - rfc7902 : display iss in response

Author: bourgeoa

.gitattributes

@@ -0,0 +1,19 @@
+# Force bash scripts to have unix line endings
+*.sh text eol=lf
+
+# Force bin files (executable scripts) to have unix line endings  
+bin/* text eol=lf
+
+# Ensure batch files on Windows keep CRLF line endings
+*.bat text eol=crlf
+
+# Binary files should not be modified
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.pdf binary
+*.zip binary
+*.tar.gz binary
+*.tgz binary

.github/workflows/ci.yml

@@ -51,17 +51,67 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
     # test code
-    - run: npm run standard
+    - run: npm run lint
     - run: npm run validate
-    - run: npm run nyc
+    - run: npm run c8
     # Test global install of the package
     - run: npm pack .
     - run: npm install -g solid-server-*.tgz
     # Run the Solid test-suite
     - run: bash test/surface/run-solid-test-suite.sh $BRANCH_NAME $REPO_NAME
+    - name: Save build
+      # if: matrix.node-version == '20.x'
+      uses: actions/upload-artifact@v5
+      with:
+        name: build
+        path: |
+          .
+          !node_modules
+        retention-days: 1
+
+  # The pipeline automate publication to npm, so that the docker build gets the correct version
+  npm-publish-build:
+    needs: [build]
+    name: Publish to npm  
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: build
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 22.x
+      - uses: rlespinasse/github-slug-action@v3.x
+      - name: Append commit hash to package version
+        run: 'sed -i -E "s/(\"version\": *\"[^\"]+)/\1-${GITHUB_SHA_SHORT}/" package.json'
+      - name: Disable pre- and post-publish actions
+        run: 'sed -i -E "s/\"((pre|post)publish)/\"ignore:\1/" package.json'
+      - uses: JS-DevTools/npm-publish@v4.1.0
+        if: github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]'
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          tag: ${{ env.GITHUB_REF_SLUG }}
+
+  npm-publish-latest:
+    needs: [build, npm-publish-build]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: build
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 20.x
+      - name: Disable pre- and post-publish actions
+        run: 'sed -i -E "s/\"((pre|post)publish)/\"ignore:\1/" package.json'
+      - uses: JS-DevTools/npm-publish@v4.1.0
+        if: github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]'
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          tag: latest  
 
-  # TODO: The pipeline should automate publication to npm, so that the docker build gets the correct version
-  #       This job will only dockerize solid-server@latest / solid-server@<tag-name> from npmjs.com!
+  # This job will only dockerize solid-server@latest / solid-server@<tag-name> from npmjs.com!
   docker-hub:
     needs: build
     name: Publish to docker hub

bin/lib/cli-utils.js

@@ -0,0 +1,54 @@
+import fs from 'fs-extra'
+import { red, cyan, bold } from 'colorette'
+import { URL } from 'url'
+import LDP from '../../lib/ldp.mjs'
+import AccountManager from '../../lib/models/account-manager.mjs'
+import SolidHost from '../../lib/models/solid-host.mjs'
+
+export function getAccountManager (config, options = {}) {
+  const ldp = options.ldp || new LDP(config)
+  const host = options.host || SolidHost.from({ port: config.port, serverUri: config.serverUri })
+  return AccountManager.from({
+    host,
+    store: ldp,
+    multiuser: config.multiuser
+  })
+}
+
+export function loadConfig (program, options) {
+  let argv = {
+    ...options,
+    version: program.version()
+  }
+  const configFile = argv.configFile || './config.json'
+  try {
+    const file = fs.readFileSync(configFile)
+    const config = JSON.parse(file)
+    argv = { ...config, ...argv }
+  } catch (err) {
+    if (typeof argv.configFile !== 'undefined') {
+      if (!fs.existsSync(configFile)) {
+        console.log(red(bold('ERR')), 'Config file ' + configFile + " doesn't exist.")
+        process.exit(1)
+      }
+    }
+    if (fs.existsSync(configFile)) {
+      console.log(red(bold('ERR')), 'config file ' + configFile + " couldn't be parsed: " + err)
+      process.exit(1)
+    }
+    console.log(cyan(bold('TIP')), 'create a config.json: `$ solid init`')
+  }
+  return argv
+}
+
+export function loadAccounts ({ root, serverUri, hostname }) {
+  const files = fs.readdirSync(root)
+  hostname = hostname || new URL(serverUri).hostname
+  const isUserDirectory = new RegExp(`.${hostname}$`)
+  return files.filter(file => isUserDirectory.test(file))
+}
+
+export function loadUsernames ({ root, serverUri }) {
+  const hostname = new URL(serverUri).hostname
+  return loadAccounts({ root, hostname }).map(userDirectory => userDirectory.substr(0, userDirectory.length - hostname.length - 1))
+}

bin/lib/cli-utils.mjs

@@ -0,0 +1,44 @@
+import { Command } from 'commander'
+import loadInit from './init.mjs'
+import loadStart from './start.mjs'
+import loadInvalidUsernames from './invalidUsernames.mjs'
+import loadMigrateLegacyResources from './migrateLegacyResources.mjs'
+import loadUpdateIndex from './updateIndex.mjs'
+import { spawnSync } from 'child_process'
+import path from 'path'
+import fs from 'fs'
+import { fileURLToPath } from 'url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+export default function startCli (server) {
+  const program = new Command()
+  program.version(getVersion())
+
+  loadInit(program)
+  loadStart(program, server)
+  loadInvalidUsernames(program)
+  loadMigrateLegacyResources(program)
+  loadUpdateIndex(program)
+
+  program.parse(process.argv)
+  if (program.args.length === 0) program.help()
+}
+
+function getVersion () {
+  try {
+    const options = { cwd: __dirname, encoding: 'utf8' }
+    const { stdout } = spawnSync('git', ['describe', '--tags'], options)
+    const { stdout: gitStatusStdout } = spawnSync('git', ['status'], options)
+    const version = stdout.trim()
+    if (version === '' || gitStatusStdout.match('Not currently on any branch')) {
+      throw new Error('No git version here')
+    }
+    return version
+  } catch (e) {
+    const pkgPath = path.join(__dirname, '../../package.json')
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'))
+    return pkg.version
+  }
+}