@pratapdd/kquery

🚀 kQuery 🚀

A light-weight clone of your oldie goldie jQuery

kQuery A light-weight clone of your oldie goldie jQuery.

Table of contents : for Evaluation

• Local Setup
• API Documentation github pages
• Playground
• Best Practices and Build Setup
• Future Enhancements
• API
• Authors and Contributors

Local Setup

Prerequisite

• node v12.14.1 and above / for Yarn users
• yarn v1.22.5

Steps to install

• npm install /
• yarn

Steps to run Tests

• npm run test /
• yarn test

Steps to commit

• git commit and follow instructions to match the semenatic release commit format

code coverage

• You can find code coverage report here in codecov Click here to go to code coverage report

API Documentation github pages

Click here to go API Documentation

***Two new apis added

kCollection.before(kCollection | htmlString)***

kCollection.after(kCollection | htmlString)***

Playground to check library in action

Click here to go to playground

Npm repository here

Click here to go to npm artifactory

github link to check gitflow and releases repository here

Click here to go to github actions

Click here to go to github releases

Best Practices and Build setup

• Eslint for lint
• Prettier for better code file formatting
• Jest for writing tests with coverage report
• husky - precommit hook to run lint and test always during new commit changes.
• added codecov support to publish coverage
• added travis build for running build https://travis-ci.com/github/pratapdd/kQuery
• I also tried another pipeline out of curiosity gitHub Actions and with that we can move away from travis and setup the workflow closely related to github. This gave advantages to create changeLog and release inside github and also with managing secrets
• added commitizine and auto validation for commit messages and proper formatting of messages.
• used rollup for bundling file to create bundles for various target environments
• gitub pages for api documentation, presently put the documentation in different directory docs/ .We can put this on different branch for document release in future.

Future Enhancements

• Introduce typescript for types.
• auto generate API documentation out of codebase something like js-doc
• Integrate Issues in github with proper ticketing in pull request template.

API

Below APIs will be made available by kQuery.

• kQuery(cssSelectorString)

• kCollection.replaceWith(kCollection)

• kCollection.style(Object)

• kCollection.remove()

• kCollection.find(cssSelectorString)

• kCollection.get()

• kCollection.before(kCollection | htmlString)***

• kCollection.after(kCollection | htmlString)***

***New APIs

Authors and Contributors

@pratapdd ... list awaiting awesome people like you

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Take your first steps by committing your changes and raise a pull request.

Backers

Thank you to all our backers! 🙏 [[Become a backer]