yanick/updux
1
0
Fork 0
Code Issues 6 Pull Requests Projects Releases 10 Wiki Activity

add prettier and eslint

Browse Source
This commit is contained in:
Yanick Champoux 2022-08-25 10:51:07 -04:00
parent 38c91d435f
commit d20f50e156
12 changed files with 1613 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.eslintignore Normal file
View File

@ -0,0 +1 @@
out/

27
.eslintrc.cjs Normal file
View File

@ -0,0 +1,27 @@
module.exports = {
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
},
env: {
es6: true,
browser: true,
},
plugins: ['@typescript-eslint','todo-plz', 'no-only-tests'],
overrides: [
],
rules: {
'todo-plz/ticket-ref': ['error', { pattern: 'GT[0-9]+' }],
'no-only-tests/no-only-tests': [
'error',
{
block: ['test'],
focus: ['only'],
},
],
},
settings: {
// ...
},
};

1
.gitignore vendored
View File

@ -6,7 +6,6 @@ package-lock.json
yarn.lock
.nyc_output/
pnpm-debug.log
pnpm-lock.yaml
yarn-error.log
GPUCache/
updux-2.0.0.tgz

22
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,22 @@
exclude: static/fontawesome|^build
default_stages:
- merge-commit
- push
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
hooks:
- id: end-of-file-fixer
stages: [merge-commit, push]
- id: trailing-whitespace
stages: [merge-commit, push]
- id: check-merge-conflict
- repo: local
hooks:
- id: lint
name: lint
entry: task lint:fix --
language: system
files: ''

9
.prettierrc.cjs Normal file
View File

@ -0,0 +1,9 @@
module.exports = {
semi: true,
trailingComma: 'all',
singleQuote: true,
printWidth: 80,
tabWidth: 4,
useTabs: false,
plugins: [],
};

3
.taprc
View File

@ -1,3 +0,0 @@
coverage: false
browser: false
test-regex: src/.*\.test.js

34
Taskfile.yaml Normal file
View File

@ -0,0 +1,34 @@
# https://taskfile.dev
version: '3'
tasks:
lint:fix:delta:
vars:
FILES:
sh: git diff-ls --diff-filter=d main | grep -v .vitebook
deps:
- task: 'lint:fix'
vars:
CLI_ARGS: '{{.FILES | catLines }}'
lint:
cmds:
- npx prettier --check {{.CLI_ARGS | default "." }}
- npx eslint {{.CLI_ARGS | default "." }}
lint:fix:
cmds:
- npx prettier --write {{.CLI_ARGS | default "." }}
- npx eslint --fix --quiet {{.CLI_ARGS | default "." }}
lint:eslint:delta:
vars:
FILES:
sh: git diff-ls --diff-filter=d main | grep -v .vitebook
cmds:
- npx eslint --format=unix {{.FILES | catLines }}
lint:eslint:
cmds:
- npx eslint {{.FILES | default "src/**" }}

10
package.json
View File

@ -1,11 +1,10 @@
{
"type": "module",
"types": "./dist",
"types": "./dist/index.d.ts",
"dependencies": {
"remeda": "^1.0.1"
},
"license": "MIT",
"type": "module",
"main": "dist/index.js",
"name": "updux",
"description": "Updeep-friendly Redux helper framework",
@ -30,8 +29,13 @@
"url": "https://github.com/yanick/updux/issues"
},
"homepage": "https://github.com/yanick/updux#readme",
"types": "./dist/index.d.ts",
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.35.1",
"@typescript-eslint/parser": "^5.35.1",
"eslint": "^8.22.0",
"eslint-plugin-no-only-tests": "^3.0.0",
"eslint-plugin-todo-plz": "^1.2.1",
"prettier": "^2.7.1",
"typescript": "^4.7.4",
"vitest": "^0.22.1"
}

1400
pnpm-lock.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

21
src/Updux.ts
View File

@ -3,7 +3,7 @@ import R from 'remeda';
/**
* Configuration object typically passed to the constructor of the class Updux.
*/
export interface UpduxConfig<TState = any,TSubduxes={}> {
export interface UpduxConfig<TState = any, TSubduxes = {}> {
/**
* Local initial state.
* @default {}
@ -18,11 +18,12 @@ export interface UpduxConfig<TState = any,TSubduxes={}> {
type StateOf<D> = D extends { initial: infer I } ? I : unknown;
export type DuxStateSubduxes<C extends {}> = (keyof C) extends never ? unknown:
{[K in keyof C]: StateOf<C[K]> };
export type DuxStateSubduxes<C extends {}> = keyof C extends never
? unknown
: { [K in keyof C]: StateOf<C[K]> };
export class Updux<TState extends any = {}, TSubduxes = {}> {
#localInitial :any= {};
#localInitial: any = {};
#subduxes;
constructor(config: UpduxConfig<TState, TSubduxes>) {
@ -31,12 +32,12 @@ export class Updux<TState extends any = {}, TSubduxes = {}> {
}
get initial(): TState & DuxStateSubduxes<TSubduxes> {
if( Object.keys(this.#subduxes).length === 0 )
return this.#localInitial;
if (Object.keys(this.#subduxes).length === 0) return this.#localInitial;
return Object.assign({},this.#localInitial, R.mapValues(
this.#subduxes, ({initial}) => initial
) );
return Object.assign(
{},
this.#localInitial,
R.mapValues(this.#subduxes, ({ initial }) => initial),
);
}
}

20
src/initial.test.ts
View File

@ -2,7 +2,7 @@ import { test, expect } from 'vitest';
import { Updux } from './Updux.js';
const bar = new Updux({initial: 123});
const bar = new Updux({ initial: 123 });
const foo = new Updux({
initial: { root: 'abc' },
@ -11,19 +11,17 @@ const foo = new Updux({
},
});
test( 'single dux', () => {
test('single dux', () => {
const foo = new Updux({
initial: { a: 1 }
initial: { a: 1 },
});
expect(foo.initial).toEqual({a:1});
} );
test( 'initial value', () => {
expect(foo.initial).toEqual({ a: 1 });
});
test('initial value', () => {
expect(foo.initial).toEqual({
root: 'abc',
bar: 123
})
} );
bar: 123,
});
});

16
tsconfig.json
View File

@ -13,7 +13,7 @@
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
@ -27,7 +27,7 @@
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
"module": "commonjs" /* Specify what module code is generated. */,
// "rootDir": "./src", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
@ -41,17 +41,17 @@
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
"allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
"allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
"declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
@ -73,12 +73,12 @@
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */