{"id":22824502,"url":"https://github.com/csprance/shotgrid-nodejs-ts","last_synced_at":"2025-03-31T00:19:22.625Z","repository":{"id":77768197,"uuid":"507409869","full_name":"csprance/shotgrid-nodejs-ts","owner":"csprance","description":null,"archived":false,"fork":false,"pushed_at":"2022-06-26T01:19:54.000Z","size":136,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T05:31:08.097Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csprance.png","metadata":{"files":{"readme":"README.TSDX.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-25T20:22:49.000Z","updated_at":"2024-10-05T02:43:58.000Z","dependencies_parsed_at":"2023-03-24T01:17:33.632Z","dependency_job_id":null,"html_url":"https://github.com/csprance/shotgrid-nodejs-ts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csprance%2Fshotgrid-nodejs-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csprance%2Fshotgrid-nodejs-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csprance%2Fshotgrid-nodejs-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csprance%2Fshotgrid-nodejs-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csprance","download_url":"https://codeload.github.com/csprance/shotgrid-nodejs-ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246396385,"owners_count":20770363,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-12T17:07:26.763Z","updated_at":"2025-03-31T00:19:22.613Z","avatar_url":"https://github.com/csprance.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\r\n# TSDX User Guide\r\n\r\nCongrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.\r\n\r\n\u003e This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.\r\n\r\n\u003e If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)\r\n\r\n## Commands\r\n\r\nTSDX scaffolds your new library inside `/src`.\r\n\r\nTo run TSDX, use:\r\n\r\n```bash\r\nnpm start # or yarn start\r\n```\r\n\r\nThis builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.\r\n\r\nTo do a one-off build, use `npm run build` or `yarn build`.\r\n\r\nTo run tests, use `npm test` or `yarn test`.\r\n\r\n## Configuration\r\n\r\nCode quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.\r\n\r\n### Jest\r\n\r\nJest tests are set up to run with `npm test` or `yarn test`.\r\n\r\n### Bundle Analysis\r\n\r\n[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.\r\n\r\n#### Setup Files\r\n\r\nThis is the folder structure we set up for you:\r\n\r\n```txt\r\n/src\r\n  index.tsx       # EDIT THIS\r\n/test\r\n  blah.test.tsx   # EDIT THIS\r\n.gitignore\r\npackage.json\r\nREADME.md         # EDIT THIS\r\ntsconfig.json\r\n```\r\n\r\n### Rollup\r\n\r\nTSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.\r\n\r\n### TypeScript\r\n\r\n`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.\r\n\r\n## Continuous Integration\r\n\r\n### GitHub Actions\r\n\r\nTwo actions are added by default:\r\n\r\n- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix\r\n- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)\r\n\r\n## Optimizations\r\n\r\nPlease see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:\r\n\r\n```js\r\n// ./types/index.d.ts\r\ndeclare var __DEV__: boolean;\r\n\r\n// inside your code...\r\nif (__DEV__) {\r\n  console.log('foo');\r\n}\r\n```\r\n\r\nYou can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.\r\n\r\n## Module Formats\r\n\r\nCJS, ESModules, and UMD module formats are supported.\r\n\r\nThe appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.\r\n\r\n## Named Exports\r\n\r\nPer Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.\r\n\r\n## Including Styles\r\n\r\nThere are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.\r\n\r\nFor vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.\r\n\r\n## Publishing to NPM\r\n\r\nWe recommend using [np](https://github.com/sindresorhus/np).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsprance%2Fshotgrid-nodejs-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsprance%2Fshotgrid-nodejs-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsprance%2Fshotgrid-nodejs-ts/lists"}