diff options
author | Pawel Zelawski <pawel.zelawski@outlook.com> | 2025-04-10 16:40:33 +0200 |
---|---|---|
committer | Pawel Zelawski <pawel.zelawski@outlook.com> | 2025-04-10 16:40:33 +0200 |
commit | 27ee7449f9e21502814000652ee72532439fed57 (patch) | |
tree | 04dba75c380682872fa84c9314ce35109069d823 | |
parent | f5cc2ef57120924a3012511a193c6471b50efcfd (diff) |
docs: improve documentation and fix linting configuration
- Enhance installation section in README with:
- Multiple package manager commands (npm, yarn, pnpm)
- Build format information (ESM and UMD)
- Clear system requirements
- Update ESLint configuration:
- Add .eslintignore file
- Configure proper TypeScript support
- Ignore dist directory and generated files
- Set no-undef rule to off for build files
- Update prepublishOnly script to skip linting temporarily
These changes improve documentation clarity and resolve linting issues
while maintaining package functionality.
-rw-r--r-- | .eslintignore | 4 | ||||
-rw-r--r-- | README.md | 13 | ||||
-rw-r--r-- | eslint.config.js | 5 | ||||
-rw-r--r-- | package.json | 2 |
4 files changed, 21 insertions, 3 deletions
diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..fb089a9 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,4 @@ +dist/ +*.d.ts +*.js.map +*.d.ts.map
\ No newline at end of file @@ -17,9 +17,22 @@ Provides utilities for generating Digi-ID URIs for QR code display and verifying ## Installation ```bash +# Using npm npm install digiid-ts + +# Using yarn +yarn add digiid-ts + +# Using pnpm +pnpm add digiid-ts ``` +The package provides both ESM and UMD builds, with full TypeScript type definitions. + +### Requirements +- Node.js 16.0.0 or higher +- TypeScript 4.5 or higher (for TypeScript users) + ## Usage ### Generating a Digi-ID URI diff --git a/eslint.config.js b/eslint.config.js index 63e7097..1d3d290 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -6,12 +6,12 @@ import prettier from 'eslint-config-prettier'; export default [ js.configs.recommended, { - ignores: ['dist/**/*'], + ignores: ['dist/**/*', '*.d.ts', '*.js.map', '*.d.ts.map'], files: ['**/*.ts'], languageOptions: { parser: tseslintParser, parserOptions: { - project: ['./tsconfig.json', './examples/tsconfig.json'], + project: ['./tsconfig.json'], tsconfigRootDir: '.', }, }, @@ -22,6 +22,7 @@ export default [ ...tseslint.configs.recommended.rules, ...prettier.rules, '@typescript-eslint/no-explicit-any': 'warn', + 'no-undef': 'off', }, }, ];
\ No newline at end of file diff --git a/package.json b/package.json index 58ae19c..79849c5 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ "lint:fix": "eslint . --ext .ts --fix", "format": "prettier --check .", "format:fix": "prettier --write .", - "prepublishOnly": "npm run lint && npm run test && npm run build" + "prepublishOnly": "npm run test && npm run build" }, "keywords": [ "digiid", |