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.

Sign up for GitHub

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

update tsconfig file and some tweaks to functions #6

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

update tsconfig file and some tweaks to functions #6

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9be7297
update tsconfig file and tweaks to functions
adam-at-brown Mar 7, 2022
756c107
pr feedback: good suggestions
adam-at-brown Mar 11, 2022
979012c
update for testing
adam-at-brown Mar 11, 2022
80f7a93
pr feedback: sync up js values
adam-at-brown Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions src/colors/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
/* eslint-disable import/prefer-default-export */
export function adjustColor(colorValue: string, changeAmount = -20) {
let color = colorValue.replace(/^#/, "");
const changePercent = changeAmount / 100;

if (color.length === 3)
color = color[0] + color[0] + color[1] + color[1] + color[2] + color[2];
color = `${color[0]}${color[0]}${color[1]}${color[1]}${color[2]}${color[2]}`;

// @ts-ignore
let [r, g, b] = color.match(/.{2}/g);
const r = parseInt(`${color[0]}${color[1]}`, 16);
const g = parseInt(`${color[2]}${color[3]}`, 16);
const b = parseInt(`${color[4]}${color[5]}`, 16);

[r, g, b] = [parseInt(r, 16), parseInt(g, 16), parseInt(b, 16)];
const newR = Math.max(
Math.min(255, Math.round(r + r * changePercent)),
0
).toString(16);
const newG = Math.max(
Math.min(255, Math.round(g + g * changePercent)),
0
).toString(16);
const newB = Math.max(
Math.min(255, Math.round(b + b * changePercent)),
0
).toString(16);

r = Math.max(Math.min(255, Math.round(r + r * changePercent)), 0).toString(
16
);
g = Math.max(Math.min(255, Math.round(g + g * changePercent)), 0).toString(
16
);
b = Math.max(Math.min(255, Math.round(b + b * changePercent)), 0).toString(
16
);

const rr = (r.length < 2 ? "0" : "") + r;
const gg = (g.length < 2 ? "0" : "") + g;
const bb = (b.length < 2 ? "0" : "") + b;
const rr = (newR.length < 2 ? "0" : "") + newR;
const gg = (newG.length < 2 ? "0" : "") + newG;
const bb = (newB.length < 2 ? "0" : "") + newB;

return `#${rr}${gg}${bb}`;
}
2 changes: 1 addition & 1 deletion src/string_formatters/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const toKebabCase = (str: string) => {
export const toCamelCase = (str: string) => {
return str
.toLowerCase()
.replace(/[^a-zA-Z0-9]+(.)/g, (m, chr) => chr.toUpperCase());
.replace(/[^a-zA-Z0-9]+(.)/g, (_, chr) => chr.toUpperCase());
};

export const capitalize = (str: string) => {
Expand Down
97 changes: 36 additions & 61 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,64 +1,39 @@
{
"include": ["src", "types", "typings/*.d.ts"],
"exclude": [
"node_modules",
"public",
"build",
"dist"
],
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
"module": "ESNext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
"jsx": "react" /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */,
"declaration": true /* Generates corresponding '.d.ts' file. */,
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist" /* Redirect output structure to the directory. */,
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
"moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": ["./src/@types"], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
},
"include": ["src/**/*", "./jest-setup.ts"]
"target": "es5",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the tsconfig documentation: "Modern browsers support all ES6 features, so ES6 is a good choice." Support does seem pretty good according to https://caniuse.com/?search=es6. I don't think we have (m)any users still on IE 11 at this point? But we should maybe try to check some analytics to validate that assumption.

"module": "esnext",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default value is "CommonJS" when target=es5. Do we have a reason to stray from that? If we change target to es6, should we also set this to es6?

"lib": ["dom", "dom.iterable", "esnext"],
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to have sensible defaults based on target. Should we just rely on those?

"outDir": "./lib",
"importHelpers": true,
"declaration": true,
"sourceMap": true,
"rootDir": "./src",
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"moduleResolution": "node",
"baseUrl": "./",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rootDir=./src requires that all input files be in ./src, so I think that means it would make sense for baseUrl=./src also? And then I think paths could just be left out?

"paths": {
"*": ["src/*", "node_modules/*"]
},
"jsx": "react",
"esModuleInterop": true,
"typeRoots": ["./@types", "./node_modules/@types"],
"resolveJsonModule": true,
"allowJs": true,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the JS settings should be in sync. Either both false or both true.

"checkJs": true,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would vote for leaving these JS settings as false in the default config and let consumers override them if necessary. I think really this should only be used for incrementally introducing TS to an existing JS codebase, which is a pretty opt-in scenario.

"forceConsistentCasingInFileNames": true,
"skipLibCheck": true,
"allowSyntheticDefaultImports": true,
"noEmit": true
}
}