diff --git a/README.md b/README.md index 9aab2ad..2b81b13 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

-Have you written some code that you're proud of? Do you want to share it as a standalone module on NPM, +Have you written some functions or React component that you're proud of? Do you want to share it as a standalone module on NPM, but find yourself unsure about the publishing process or how to manage the lifecycle of an open-source library? Look no further - ts-ci is here to jumpstart your journey towards becoming a proficient NPM module author. diff --git a/README.template.md b/README.template.md index 240f4a8..04a3e2a 100644 --- a/README.template.md +++ b/README.template.md @@ -31,14 +31,15 @@ $ npm install --save #{REPO_NAME}# ``` ```typescript -import { myFunction, myObject } from "#{REPO_NAME}#"; +import { myFunction, myObject, MyReactComponent } from "#{REPO_NAME}#"; ``` -Specific imports: +Specific imports, only import what you need: ```typescript import { myFunction } from "#{REPO_NAME}#/myFunction"; import { myObject } from "#{REPO_NAME}#/myObject"; +import MyReactComponent from "#{REPO_NAME}#/MyReactComponent"; ``` # Contributing diff --git a/package.json b/package.json index 3234b2e..b781349 100755 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "!dist/tsconfig.tsbuildinfo" ], "keywords": [], - "homepage": "https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#", + "homepage": "https://github.com/garronej/update-ts-ci", "devDependencies": { "@types/node": "^20.2.1", "typescript": "^5.0.4", @@ -52,6 +52,8 @@ "husky": "^4.3.8", "lint-staged": "^11.1.1", "prettier": "^2.8.8", - "ts-node": "^10.9.1" + "ts-node": "^10.9.1", + "react": "^18.2.0", + "@types/react": "^18.2.6" } } diff --git a/src/MyReactComponent.tsx b/src/MyReactComponent.tsx new file mode 100644 index 0000000..ed2a371 --- /dev/null +++ b/src/MyReactComponent.tsx @@ -0,0 +1,7 @@ + + +export function MyReactComponent() { + return
My React Component
; +} + +export default MyReactComponent; \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 64884e2..e8b0af9 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,2 +1,3 @@ export * from "./myFunction"; export * from "./myObject"; +export * from "./MyReactComponent"; diff --git a/tsconfig.json b/tsconfig.json index 9232194..0b0a147 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -3,10 +3,10 @@ "module": "CommonJS", "target": "es5", "moduleResolution": "node", - "lib": ["es2015", "DOM"], + "lib": ["es2015","DOM","ES2019.Object"], "esModuleInterop": true, "declaration": true, - // Do not change or the linkinkg cript will stop working + // Do not change or the linking script will stop working "outDir": "./dist", "sourceMap": true, "newLine": "LF", @@ -18,5 +18,9 @@ "jsx": "react-jsx", "noFallthroughCasesInSwitch": true }, - "include": ["src"] -} + "include": ["src"], + "exclude": [ + "src/**/*.deno.ts", + "src/**/*.deno.tsx" + ] +} \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index b50cd07..aadc4d5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -155,6 +155,25 @@ resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0" integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA== +"@types/prop-types@*": + version "15.7.5" + resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.5.tgz#5f19d2b85a98e9558036f6a3cacc8819420f05cf" + integrity sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w== + +"@types/react@^18.2.6": + version "18.2.6" + resolved "https://registry.yarnpkg.com/@types/react/-/react-18.2.6.tgz#5cd53ee0d30ffc193b159d3516c8c8ad2f19d571" + integrity sha512-wRZClXn//zxCFW+ye/D2qY65UsYP1Fpex2YXorHc8awoNamkMZSvBxwxdYVInsHOZZd2Ppq8isnSzJL5Mpf8OA== + dependencies: + "@types/prop-types" "*" + "@types/scheduler" "*" + csstype "^3.0.2" + +"@types/scheduler@*": + version "0.16.3" + resolved "https://registry.yarnpkg.com/@types/scheduler/-/scheduler-0.16.3.tgz#cef09e3ec9af1d63d2a6cc5b383a737e24e6dcf5" + integrity sha512-5cJ8CB4yAx7BH1oMvdU0Jh9lrEXyPkar6F9G/ERswkCuvP4KQZfZkSjcMbAICCpQTN4OuZn8tz0HiKv9TGZgrQ== + "@types/semver@^7.3.12": version "7.5.0" resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.5.0.tgz#591c1ce3a702c45ee15f47a42ade72c2fd78978a" @@ -469,6 +488,11 @@ cross-spawn@^7.0.2, cross-spawn@^7.0.3: shebang-command "^2.0.0" which "^2.0.1" +csstype@^3.0.2: + version "3.1.2" + resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.2.tgz#1d4bf9d572f11c14031f0436e1c10bc1f571f50b" + integrity sha512-I7K1Uu0MBPzaFKg4nI5Q7Vs2t+3gWWW648spaF+Rg7pI9ds18Ugn+lvg4SHczUdKlHI5LWBXyqfS8+DufyBsgQ== + debug@^4.1.1, debug@^4.3.1: version "4.3.2" resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.2.tgz#f0a49c18ac8779e31d4a0c6029dfb76873c7428b" @@ -941,7 +965,7 @@ isexe@^2.0.0: resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= -js-tokens@^4.0.0: +"js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== @@ -1045,6 +1069,13 @@ log-update@^4.0.0: slice-ansi "^4.0.0" wrap-ansi "^6.2.0" +loose-envify@^1.1.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" + integrity sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q== + dependencies: + js-tokens "^3.0.0 || ^4.0.0" + lru-cache@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" @@ -1249,6 +1280,13 @@ queue-microtask@^1.2.2: resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== +react@^18.2.0: + version "18.2.0" + resolved "https://registry.yarnpkg.com/react/-/react-18.2.0.tgz#555bd98592883255fa00de14f1151a917b5d77d5" + integrity sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ== + dependencies: + loose-envify "^1.1.0" + resolve-from@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6"