Skip to content

Commit

Permalink
Add sample project for experimentations and testing (#6)
Browse files Browse the repository at this point in the history
We are using a sample project created with `npx create-next-app` for
testing the plugin code during the development. The project uses all the
default files created by the mentioned command except, the `className`
values on each JSX element in `app/page.tsx` have been updated to use
simple strings. The plugin code transforms the string classnames
(`className="my-class"`) into object notations
(`className={style.myClass}`) seamlessly 😉};
  • Loading branch information
tusharsnx authored Jun 12, 2024
1 parent d6cae22 commit 9b83288
Show file tree
Hide file tree
Showing 22 changed files with 1,242 additions and 47 deletions.
142 changes: 135 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,137 @@
**/node_modules/
dev/
.vscode/**
!.vscode/launch.json
!.vscode/tasks.json
!.vscode/settings.json

# test projects for testing and prototyping
test-projects/
dev

.vscode/
**/coverage/
dist/
# 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
.cache

# 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.*
46 changes: 46 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Next.js: debug server-side",
"preLaunchTask": "Build",
"type": "node",
"env": {
"NODE_OPTIONS": "--inspect",
},
"request": "launch",
"cwd": "${workspaceFolder}/test-projects/nextjs",
"program": "${workspaceFolder}/test-projects/nextjs/node_modules/next/dist/bin/next",
"args": [
"dev"
],
},
{
"name": "Next.js: debug client-side",
"preLaunchTask": "Build",
"type": "chrome",
"request": "launch",
"cwd": "${workspaceFolder}/test-projects/nextjs",
"url": "http://localhost:3000"
},
{
"name": "Next.js: debug full stack",
"preLaunchTask": "Build",
"type": "node",
"request": "launch",
"env": {
"NODE_OPTIONS": "--inspect"
},
"program": "${workspaceFolder}/test-projects/nextjs/node_modules/next/dist/bin/next",
"args": [
"dev",
],
"cwd": "${workspaceFolder}/test-projects/nextjs",
"serverReadyAction": {
"pattern": "- Local:.+(https?://.+)",
"uriFormat": "%s",
"action": "debugWithChrome"
},
}
]
}
8 changes: 8 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"editor.formatOnSave": true,
"search.exclude": {
"**/node_modules": true,
"**/dist": true,
"**/dev": true,
}
}
10 changes: 10 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "build:nowatch",
"label": "Build"
},
]
}
8 changes: 5 additions & 3 deletions jest.config.ts → jest.config.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import type { Config } from "jest";

const config: Config = {
/**
* @type {import("ts-jest").JestConfigWithTsJest}
*/
let config = {
preset: "ts-jest/presets/default-esm",
testEnvironment: "node",
extensionsToTreatAsEsm: [".ts"],
verbose: true,
};

export default config;
32 changes: 13 additions & 19 deletions package-lock.json

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

14 changes: 8 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"repository": "github:tusharsnn/jsx-css-module-transforms",
"type": "module",
"module": "dist/index.js",
"types": "dist/index.d.ts",
"types": "dist/index.d.cts",
"main": "dist/index.cjs",
"exports": {
".": {
Expand All @@ -23,19 +23,22 @@
"module-classname-transforms"
],
"scripts": {
"build": "NODE_ENV=production npx tsup-node --config tsup.build.config.ts",
"release": "npx tsup-node --config tsup.build.config.ts",
"build": "npx tsup-node --config tsup.build.config.ts --sourcemap --watch",
"build:nowatch": "npx tsup-node --config tsup.build.config.ts --sourcemap",
"dev": "npx tsup-node --watch",
"dev:nowatch": "npx tsup-node",
"test": "npm run dev:nowatch && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --verbose",
"test:cov": "npm run dev:nowatch && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --verbose --coverage"
"test": "npm run dev:nowatch && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest",
"test:cov": "npm run dev:nowatch && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --coverage"
},
"dependencies": {
"@babel/core": "^7.24.3",
"@babel/plugin-syntax-jsx": "^7.24.7",
"@babel/plugin-syntax-typescript": "^7.24.7",
"chalk": "^4.1.2",
"unplugin": "^1.10.1"
},
"peerDependencies": {
"@babel/plugin-syntax-jsx": "^7.24.1",
"webpack": "^5.91.0"
},
"peerDependenciesMeta": {
Expand All @@ -44,7 +47,6 @@
}
},
"devDependencies": {
"@babel/plugin-syntax-jsx": "^7.17.12",
"@types/babel__core": "^7.20.5",
"@types/jest": "^29.5.12",
"@types/node": "^20.14.2",
Expand Down
Loading

0 comments on commit 9b83288

Please sign in to comment.