Skip to content

Commit

Permalink
fix: 🐛 improve typescript type definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
ed-software committed Jan 20, 2023
1 parent 2bf919d commit 862a857
Show file tree
Hide file tree
Showing 15 changed files with 496 additions and 157 deletions.
144 changes: 144 additions & 0 deletions .npmignore
@@ -0,0 +1,144 @@
# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# End of https://www.toptal.com/developers/gitignore/api/node
1 change: 1 addition & 0 deletions .nvmrc
@@ -0,0 +1 @@
v18.12.1
27 changes: 27 additions & 0 deletions .prettierignore
@@ -0,0 +1,27 @@
# Ignore artifacts:
build
coverage
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
10 changes: 10 additions & 0 deletions .prettierrc.json
@@ -0,0 +1,10 @@
{
"tabWidth": 2,
"useTabs": true,
"printWidth": 100,
"semi": true,
"singleQuote": true,
"jsxSingleQuote": true,
"arrowParens": "always",
"trailingComma": "es5"
}
30 changes: 15 additions & 15 deletions .swcrc
@@ -1,17 +1,17 @@
{
"minify": true,
"jsc": {
"minify": {
"compress": {
"unused": true
},
"mangle": true
},
"parser": {
"syntax": "typescript",
"tsx": false,
"decorators": true,
"dynamicImport": true
}
}
"minify": true,
"jsc": {
"minify": {
"compress": {
"unused": true
},
"mangle": true
},
"parser": {
"syntax": "typescript",
"tsx": false,
"decorators": true,
"dynamicImport": true
}
}
}
11 changes: 8 additions & 3 deletions jest.config.cjs
@@ -1,5 +1,10 @@
const fs = require('fs');

const config = JSON.parse(fs.readFileSync(`${__dirname}/.swcrc`, 'utf-8'));

module.exports = {
transform: {
"^.+\\.(t|j)sx?$": ["@swc/jest"],
},
transform: {
'^.+\\.(t|j)sx?$': ['@swc/jest', { ...config }],
},
extensionsToTreatAsEsm: ['.ts', '.tsx'],
};
47 changes: 47 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 40 additions & 3 deletions package.json
@@ -1,21 +1,58 @@
{
"name": "merge-tw-props",
"description": "Utility for intelligently merging React component props using Tailwind.",
"private": false,
"version": "1.0.0",
"license": "Apache-2.0",
"type": "module",
"contributors": [
"Ed Jones"
],
"engines": {
"node": "18.12.1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/ed-software/merge-tw-props.git"
},
"keywords": [
"React",
"Tailwind",
"TailwindCSS",
"mergeProps"
],
"bugs": {
"url": "https://github.com/ed-software/merge-tw-props/issues"
},
"homepage": "https://github.com/ed-software/merge-tw-props#readme",
"files": [
"dist"
],
"types": "./dist/index.d.ts",
"exports": {
".": {
"import": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
},
"./package.json": "./package.json"
},
"scripts": {
"build": "tsc && swc src -d dist",
"test": "jest"
"test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest"
},
"dependencies": {
"react-merge-refs": "^2.0.1",
"tailwind-merge": "^1.8.1"
},
"devDependencies": {
"@swc/cli": "^0.1.59",
"@swc/core": "^1.3.27",
"@swc/jest": "^0.2.24",
"@types/jest": "^29.2.6",
"cross-env": "^7.0.3",
"jest": "^29.3.1",
"typescript": "^4.9.3",
"@swc/jest": "^0.2.24"
"typescript": "^4.9.3"
}
}

0 comments on commit 862a857

Please sign in to comment.