From ded03f9f0129ad5dd8043a21a71ed3157a75c61e Mon Sep 17 00:00:00 2001 From: "Ava Gaiety W." Date: Tue, 5 Dec 2023 16:57:00 -0600 Subject: [PATCH] Initial tests and working concept --- .gitignore | 175 ++++++++++++++++++++++++++++++++++++++ README.md | 17 ++++ bun.lockb | Bin 0 -> 5040 bytes bunfig.toml | 2 + index.ts | 29 +++++++ package.json | 12 +++ tests/all.test.ts | 43 ++++++++++ tests/helpers/happydom.ts | 3 + tsconfig.json | 22 +++++ 9 files changed, 303 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100755 bun.lockb create mode 100644 bunfig.toml create mode 100644 index.ts create mode 100644 package.json create mode 100644 tests/all.test.ts create mode 100644 tests/helpers/happydom.ts create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..468f82a --- /dev/null +++ b/.gitignore @@ -0,0 +1,175 @@ +# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore + +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Caches + +.cache + +# 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/) + +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +# 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.* + +# IntelliJ based IDEs +.idea + +# Finder (MacOS) folder config +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..a062ff8 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# discov-selector + +## To Use + +WIP: npm package coming soon, hopefully, maybe... this is an early proof of concept + +## To install dependencies + +```bash +bun install +``` + +## To test + +```bash +bun test +``` diff --git a/bun.lockb b/bun.lockb new file mode 100755 index 0000000000000000000000000000000000000000..d267885227c4f29b44c94b27af86d57b971b5200 GIT binary patch literal 5040 zcmeHK4Ny~87JlGU6e*x$wWF3Gx>n^SB!r)8h}3qi0%8$Z&;pu-m+)*zAn%1A#RUid z7NsMs)k+0H(E3AVbj4Dwvuvp-RytIz7EAprq9`J0TXYcIbCY*TDlIVWbY`csXXfSH z`|kO^d+xdC-k0OpIp$MfTWG1)zIypdXW zsA%u1R!!Z;(f1}l-1N#co9>|L%bkVB&@X14Z!IbHELixoBt3>KPi0qqTw5+b9v3bX zJb7Vq#n^zN_R<+wHyIa94;&f)n2{c+-<=n&pZ3F(SL=68&GeYLj#k2Sze`Y5k<5W- zHmn2lA^!&>7{3yXmjE6G7UDw;84MU~FuoDmvfqJ^2FK?Cez5am_wf9?c|7jp@qsk9 zzXN#WKe8VN&tUz)_yA}G03P+x9^m)T>{qZI0tN%#u3ziEgBX7f8h(H$!DMJ(vtNCK z@gyu5tsnW0@JJ6vFg}>aBP@y?em@uvWRD&sNTa#YI?z6#TttF2dOwoa_yQP6gSmKSaXkTZi68^X+MO-;tWCW@*sPT3e8p1tgw6UWD5vZeur(#LYpIXOKv;u3hXNL2#2{bul4?r`BOIU+gf3_IJWa? zw|&$Irepi184f)sI-(*DY;OJ3y)HL!{jr{qIX&*z+;4}R@-O(YCva48L+v?vV`%px zzvcy2yg1HindCI@akD0Qa$miFJKMg{QL%02n!NHJ#y{e_>@csEcYHhcQDl|(2M+O@ znqPLidN1bSiW?7PJF3<5{@$bx?YbYJv*JbhfQ2l)mebI9=J?m4pOZfSn7SQ3;p@mu|v$+Mg)3cP>_`)hqakcxcYnRR(i zN0nzO^5Pp#yCsj>0%P}bTink}{12bbintte@7r7F=eJ!k_%0vvxyD(WbmHW>+?N+l z)Z6czTe}fyO?1uL%wYLvADD9HP=qk zes#q99be2&Sw7*LiU}c44h-8?wkWGTz4fd2G@WgCt$5*^+$&_{e3k2ld2-i)l6+3G zHtNpU6(18N8|3Bgc^BGk)0#3Wv#vcpdAQ@^yQ!x9e%tXQ`d1eZF(A(fd{ zw=C28e)}!>|6~5V5h&t6?nilTFJlcVA){kCg;p!XC5ABEK+|%8#8bdBD`~yjLm(9> zw2VflSM!%d&oi^2NTKt6o#%6S!5lk#nbAuk2iUI=pd3ZtOZ06+xsJXW=zd3cF}gR= z9fx@Rc)s{S@FIJ}iMSCjaux9)Uc`y!Ky%@F-sd^%9pNR2z3gp?PmIwI7VgvQx7f09 zT)*Ht!`UX*Tj(kDBnVs~;YwzB?_U92L*ZIyxUE*f(JV(0xSGOMkFAYZA{2WHy$D<{ z;kw4wCRQx;7K#Z1S5&z2fe|T;fCsn+!?hBOcnW=hjKI|xu9{%P*X%W}-*BA;BNFon zuJCXr1|wePk-qcr(-64&!&REC%@l}&GyMM*@P*TIUjIDjSUMq@HVFTk%Fza$LL0^z z7@bBg5L>pu&$0!ked1V^Nmq5b>@jTJ;(`ig^v>yOiL7l>(s7PuX#;S^To9~TtPXk{ z0LcL9nYq@_`Vj2~vPY`LedZj{38E6f|as~yMp_1KX8qaZw>@1OpA4?PJ5))RiLcKvF>a`J3 zmNq4ZP>a2VoMvS|(0=Czy1ouke14gTvE%*BU|Ad`>TO$-s907Akx(Skj7qOdrnC%4 zr_f3!PD`OaZD1L_j!lVIa48y!)~WPyu(NzOfk~iIbo!b9IZIg6b8je9P7V;K=cc!? zV23DE&JVz1Ss)NtI+Q8-5mxRmfYU3K2xJ12SFA!!8z`kw4XU3tTAKm0br<{sz5)E| z8*a3~K6^l!PW%8|_;LXT+@wsm%K$h_8UWJLfi#9Y3t`RY(|jiTiG}4{0gt6ac?-SF MaWJ3O|GnS;0<)3rVE_OC literal 0 HcmV?d00001 diff --git a/bunfig.toml b/bunfig.toml new file mode 100644 index 0000000..4192f61 --- /dev/null +++ b/bunfig.toml @@ -0,0 +1,2 @@ +[test] +preload = "./tests/helpers/happydom.ts" diff --git a/index.ts b/index.ts new file mode 100644 index 0000000..07061eb --- /dev/null +++ b/index.ts @@ -0,0 +1,29 @@ +class Discov { + readonly rootElement: HTMLElement = document + baseElement: HTMLElement + query: string = '' + + constructor (rootElement?: HTMLElement) { + if (rootElement !== undefined) this.rootElement = rootElement + this.baseElement = this.rootElement + this.query = '' + } + + tag(tagName: string): HTMLElement { + this.query += ` ${tagName}` + return this + } + + class(className: string): HTMLElement { + if (className.charAt(0) == '.') console.warn('class target contains a "." and may not match') + this.query += `.${className}` + return this + } + + get element(): HTMLElement { + if (this.query == '') return this.baseElement + return this.baseElement.querySelector(this.query) + } +} + +export default (rootElement?: HTMLElement) => new Discov(rootElement) diff --git a/package.json b/package.json new file mode 100644 index 0000000..874adac --- /dev/null +++ b/package.json @@ -0,0 +1,12 @@ +{ + "name": "discov-selector", + "module": "index.ts", + "type": "module", + "devDependencies": { + "@happy-dom/global-registrator": "^12.10.3", + "bun-types": "latest" + }, + "peerDependencies": { + "typescript": "^5.0.0" + } +} \ No newline at end of file diff --git a/tests/all.test.ts b/tests/all.test.ts new file mode 100644 index 0000000..08b5be7 --- /dev/null +++ b/tests/all.test.ts @@ -0,0 +1,43 @@ +import { expect, test } from 'bun:test' +import discov from '../index.ts' + +test('can select a simple passed in element', () => { + expect( + discov(document.body) + .element + ).toBe(document.body) +}) + +test('can target by tag', () => { + document.body.innerHTML = `` + + let buttonElement = document.querySelector('button') + expect( + discov(document.body) + .tag('button') + .element + ).toBe(buttonElement) +}) + +test('can target by class', () => { + document.body.innerHTML = `` + + let buttonElement = document.querySelector('button') + expect( + discov(document.body) + .class('my-class') + .element + ).toBe(buttonElement) +}) + +test('can target by tag with class', () => { + document.body.innerHTML = `` + + let buttonElement = document.querySelector('button') + expect( + discov(document.body) + .tag('button') + .class('my-class') + .element + ).toBe(buttonElement) +}) diff --git a/tests/helpers/happydom.ts b/tests/helpers/happydom.ts new file mode 100644 index 0000000..ce01084 --- /dev/null +++ b/tests/helpers/happydom.ts @@ -0,0 +1,3 @@ +import { GlobalRegistrator } from "@happy-dom/global-registrator" + +GlobalRegistrator.register() diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..dc3d0a3 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "lib": ["ESNext", "dom"], + "module": "esnext", + "target": "esnext", + "moduleResolution": "bundler", + "moduleDetection": "force", + "allowImportingTsExtensions": true, + "noEmit": true, + "composite": true, + "strict": true, + "downlevelIteration": true, + "skipLibCheck": true, + "jsx": "react-jsx", + "allowSyntheticDefaultImports": true, + "forceConsistentCasingInFileNames": true, + "allowJs": true, + "types": [ + "bun-types" // add Bun global + ] + } +}