forked from FINAKON/HelpProject
Bhargava
6063bd1724
1. Initial Commit - a boiler plate code and POC to realize the concept of context
sensitive help
2. Frontend code written in ReactJS
3. Backend code written in Java, Spring Boot Framework
4. Frontend Start:
pre-requisites : node, npm
npm run dev ==> to start the frontend vite server
5. Backend Start:
pre-requisites : java, mvn
mvn spring-boot:run ==> to start the backend server
6. Visit http://localhost:5173/ for basic demo of help, press F1 in textboxes
7. Visit http://localhost:5173/editor and enter "admin123" to add/modify texts.
Happy Coding !!!
Thank you,
Bhargava.
73 lines
3.7 KiB
Markdown
73 lines
3.7 KiB
Markdown
# tinyglobby
|
|
|
|
[](https://npmjs.com/package/tinyglobby)
|
|
[](https://npmjs.com/package/tinyglobby)
|
|
|
|
A fast and minimal alternative to globby and fast-glob, meant to behave the same way.
|
|
|
|
Both globby and fast-glob present some behavior no other globbing lib has,
|
|
which makes it hard to manually replace with something smaller and better.
|
|
|
|
This library uses only two subdependencies, compared to `globby`'s [23](https://npmgraph.js.org/?q=globby@14.1.0)
|
|
and `fast-glob`'s [17](https://npmgraph.js.org/?q=fast-glob@3.3.3).
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import { glob, globSync } from 'tinyglobby';
|
|
|
|
await glob(['files/*.ts', '!**/*.d.ts'], { cwd: 'src' });
|
|
globSync(['src/**/*.ts'], { ignore: ['**/*.d.ts'] });
|
|
```
|
|
|
|
## API
|
|
|
|
- `glob(patterns: string | string[], options: GlobOptions): Promise<string[]>`: Returns a promise with an array of matches.
|
|
- `globSync(patterns: string | string[], options: GlobOptions): string[]`: Returns an array of matches.
|
|
- `convertPathToPattern(path: string): string`: Converts a path to a pattern depending on the platform.
|
|
- `escapePath(path: string): string`: Escapes a path's special characters depending on the platform.
|
|
- `isDynamicPattern(pattern: string, options?: GlobOptions): boolean`: Checks if a pattern is dynamic.
|
|
|
|
## Options
|
|
|
|
- `patterns`: An array of glob patterns to search for. Defaults to `['**/*']`.
|
|
- `ignore`: An array of glob patterns to ignore.
|
|
- `cwd`: The current working directory in which to search. Defaults to `process.cwd()`.
|
|
- `absolute`: Whether to return absolute paths. Defaults to `false`.
|
|
- `dot`: Whether to allow entries starting with a dot. Defaults to `false`.
|
|
- `deep`: Maximum depth of a directory. Defaults to `Infinity`.
|
|
- `followSymbolicLinks`: Whether to traverse and include symbolic links. Defaults to `true`.
|
|
- `caseSensitiveMatch`: Whether to match in case-sensitive mode. Defaults to `true`.
|
|
- `expandDirectories`: Whether to expand directories. Disable to best match `fast-glob`. Defaults to `true`.
|
|
- `onlyDirectories`: Enable to only return directories. Disables `onlyFiles` if set. Defaults to `false`.
|
|
- `onlyFiles`: Enable to only return files. Defaults to `true`.
|
|
- `debug`: Enable debug logs. Useful for development purposes.
|
|
|
|
## Used by
|
|
|
|
`tinyglobby` is downloaded many times by projects all around the world. Here's a partial list of notable projects that use it:
|
|
|
|
<!-- should be sorted by weekly download count -->
|
|
- [`vite`](https://github.com/vitejs/vite)
|
|
- [`pnpm`](https://github.com/pnpm/pnpm)
|
|
- [`node-gyp`](https://github.com/nodejs/node-gyp)
|
|
- [`eslint-import-resolver-typescript`](https://github.com/import-js/eslint-import-resolver-typescript)
|
|
- [`vitest`](https://github.com/vitest-dev/vitest)
|
|
- [`copy-webpack-plugin`](https://github.com/webpack-contrib/copy-webpack-plugin)
|
|
- [`storybook`](https://github.com/storybookjs/storybook)
|
|
- [`ts-morph`](https://github.com/dsherret/ts-morph)
|
|
- [`nx`](https://github.com/nrwl/nx)
|
|
- [`sort-package-json`](https://github.com/keithamus/sort-package-json)
|
|
- [`unimport`](https://github.com/unjs/unimport)
|
|
- [`tsup`](https://github.com/egoist/tsup)
|
|
- [`lerna`](https://github.com/lerna/lerna)
|
|
- [`cspell`](https://github.com/streetsidesoftware/cspell)
|
|
- [`nuxt`](https://github.com/nuxt/nuxt)
|
|
- [`postcss-mixins`](https://github.com/postcss/postcss-mixins)
|
|
- [`astro`](https://github.com/withastro/astro)
|
|
- [`unocss`](https://github.com/unocss/unocss)
|
|
- [`vitepress`](https://github.com/vuejs/vitepress)
|
|
- [`pkg-pr-new`](https://github.com/stackblitz-labs/pkg.pr.new)
|
|
- Your own project? [Open an issue](https://github.com/SuperchupuDev/tinyglobby/issues)
|
|
if you feel like this list is incomplete.
|