Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stanfordspezi/spezi-web-configurations

Shared configurations for the Spezi Web Ecosystem

https://github.com/stanfordspezi/spezi-web-configurations

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Shared configurations for the Spezi Web Ecosystem

Basic Info
  • Host: GitHub
  • Owner: StanfordSpezi
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Size: 572 KB
Statistics
  • Stars: 3
  • Watchers: 8
  • Forks: 0
  • Open Issues: 12
  • Releases: 9
Created over 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

Biodesign Digital Health Spezi Web Configurations

Build and Test Deployment DOI

Getting Started

A shared linting and formatter configurations. Uses Prettier and ESLint. Pre-configured for you to easily plug into your codebases.

Configurations are opinionated and strict. We aim to catch as many possible mistakes or elements we consider harmful practices early. Some rules are meant to be broken once in a while, with an explanation comment around them.

Installation

Install dependencies:

bash npm install --save-dev prettier eslint @stanfordspezi/spezi-web-configurations

Create eslint.config.js file.

If aiming for React, use:

```javascript const { getEslintReactConfig } = require('@stanfordspezi/spezi-web-configurations')

module.exports = getEslintReactConfig({ tsconfigRootDir: __dirname }) ```

If aiming for Node application, use:

```javascript const { getEslintNodeConfig } = require('@stanfordspezi/spezi-web-configurations')

module.exports = getEslintNodeConfig({ tsconfigRootDir: __dirname }) ```

Create .prettierrc.js file:

```javascript const { prettierConfig } = require("@stanfordspezi/spezi-web-configurations");

module.exports = prettierConfig; ```

Now, when you run eslint . --fix, code is going to be linted and formatted.

ESLint customization

We aim to make this config mostly plug and play. You can adjust ESLint to your needs by passing additional configuration pieces.

javascript module.exports = [ ...getEslintNodeConfig({ tsconfigRootDir: __dirname }), { ignores: ["lib/**/*"], // Ignore generated build files }, { rules: { "@typescript-eslint/no-non-null-assertion": "off", // ignore unwanted rule }, }, ]

For more complex scenarios, we expose smaller pieces of configuration. You can use them and do micro-adjustments. This is not the recommended approach.

```javascript const { getEslintRules, getNodeGlobals, getPreferArrowFunctions, getReactPlugins, getPrettierPlugin, getTslint, } = require("@stanfordspezi/spezi-web-configurations"); const tseslint = require("typescript-eslint");

module.exports = tseslint.config( ...getEslintRules(), getNodeGlobals(), { ...getTslint(), languageOptions: { ecmaVersion: 2020, globals: globals.browser, parserOptions: { projectService: true, tsconfigRootDir, }, }, }, getPreferArrowFunctions(), ...getReactPlugins(), ...getPrettierPlugin(), ); ```

License

This project is licensed under the MIT License. See Licenses for more information.

Contributors

This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University. See CONTRIBUTORS.md for a full list of all Next.js Template contributors.

Stanford Byers Center for Biodesign Logo Stanford Byers Center for Biodesign Logo

Owner

  • Name: Stanford Spezi
  • Login: StanfordSpezi
  • Kind: organization

Citation (CITATION.cff) 

#
# This source file is part of the Stanford Biodesign Digital Health Spezi Web Configurations open-source project
#
# SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#

cff-version: 1.2.0
message: 'If you use this software, please cite it as below.'
authors:
  - family-names: 'Schmiedmayer'
    given-names: 'Paul'
    orcid: 'https://orcid.org/0000-0002-8607-9148'
  - family-names: 'Ravi'
    given-names: 'Vishnu'
    orcid: 'https://orcid.org/0000-0003-0359-1275'
  - family-names: 'Arkadiusz'
    given-names: 'Bachorski'
title: 'spezi-web-configurations'
url: 'https://github.com/StanfordSpezi/spezi-web-configurations

GitHub Events

Total
  • Create event: 29
  • Issues event: 9
  • Release event: 7
  • Watch event: 3
  • Delete event: 19
  • Issue comment event: 10
  • Member event: 1
  • Push event: 33
  • Pull request review event: 24
  • Pull request review comment event: 9
  • Pull request event: 40
Last Year
  • Create event: 29
  • Issues event: 9
  • Release event: 7
  • Watch event: 3
  • Delete event: 19
  • Issue comment event: 10
  • Member event: 1
  • Push event: 33
  • Pull request review event: 24
  • Pull request review comment event: 9
  • Pull request event: 40

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 5
  • Total pull requests: 21
  • Average time to close issues: 8 minutes
  • Average time to close pull requests: 9 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.14
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 5
  • Pull requests: 21
  • Average time to close issues: 8 minutes
  • Average time to close pull requests: 9 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.14
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
  • arkadiuszbachorski (4)
Pull Request Authors
  • arkadiuszbachorski (18)
  • dependabot[bot] (4)
Top Labels
Issue Labels
enhancement (4)
Pull Request Labels
dependencies (7) enhancement (5) bug (1) javascript (1)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 207 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
  • Total maintainers: 1
npmjs.org: @stanfordspezi/spezi-web-configurations

Stanford Biodesign Digital Health Spezi Web Configurations

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 207 Last month
Rankings
Dependent repos count: 25.1%
Average: 30.7%
Dependent packages count: 36.4%
Maintainers (1)
pschmiedmayer
Last synced: 10 months ago

Dependencies

.github/workflows/build-and-test.yml actions
.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • github/codeql-action/analyze v3 composite
  • github/codeql-action/init v3 composite
.github/workflows/main.yml actions
.github/workflows/monthly-markdown-link-check.yml actions
Dockerfile docker
  • base latest build
  • node 18-alpine build
docker-compose-development.yml docker
  • stanfordbdgh/nextjstemplate dev
  • traefik v2.4
docker-compose.yml docker
  • ghcr.io/stanfordbdhg/nextjstemplate latest
  • traefik v2.4
package-lock.json npm
  • 694 dependencies
package.json npm
  • @testing-library/jest-dom ^6 development
  • @testing-library/react ^15 development
  • @total-typescript/ts-reset ^0.5.1 development
  • @types/jest ^29 development
  • @types/node ^20 development
  • @types/react ^18 development
  • @types/react-dom ^18 development
  • @typescript-eslint/eslint-plugin ^7 development
  • @typescript-eslint/parser ^7 development
  • autoprefixer ^10 development
  • concurrently ^8 development
  • eslint ^8 development
  • eslint-config-next ^14 development
  • eslint-config-prettier ^9 development
  • eslint-plugin-import ^2 development
  • eslint-plugin-prettier ^5 development
  • jest ^29 development
  • jest-environment-jsdom ^29 development
  • postcss ^8 development
  • prettier ^3 development
  • tailwindcss ^3 development
  • ts-jest ^29 development
  • typedoc ^0.25 development
  • typescript ^5 development
  • @stanfordbdhg/example-package file:./packages/example-package
  • next ^14
  • prettier-plugin-tailwindcss ^0.5.14
  • react ^18
  • react-dom ^18
  • sharp ^0.33
packages/example-package/package.json npm