commit ded03f9f0129ad5dd8043a21a71ed3157a75c61e Author: Ava Gaiety W. Date: Tue Dec 5 16:57:00 2023 -0600 Initial tests and working concept 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 0000000..d267885 Binary files /dev/null and b/bun.lockb differ 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 + ] + } +}