{"_id":"@dharpa/kiara-svelte-components","name":"@dharpa/kiara-svelte-components","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@dharpa/kiara-svelte-components","version":"0.0.1","license":"MPL-2.0","homepage":"https://github.com/DHARPA-Project/kiara-svelte-components","bugs":{"url":"https://github.com/DHARPA-Project/kiara-svelte-components/issues"},"contributors":[{"name":"Caro Appleby","email":"hi@caro.fyi"}],"repository":{"type":"git","url":"git+https://github.com/DHARPA-Project/kiara-svelte-components.git"},"scripts":{"dev":"vite dev","build":"vite build && npm run package","preview":"vite preview","package":"svelte-kit sync && svelte-package && publint","prepublishOnly":"npm run package","test":"npm run test:integration && npm run test:unit","check":"svelte-kit sync && svelte-check --tsconfig ./tsconfig.json","check:watch":"svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch","lint":"prettier --check . && eslint .","format":"prettier --write .","test:integration":"playwright test","test:unit":"vitest run","test:ui":"vitest --ui --coverage.enabled=true","test:coverage":"vitest run --coverage","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"exports":{".":{"types":"./dist/index.d.ts","svelte":"./dist/index.js"}},"peerDependencies":{"svelte":"^4.0.0"},"devDependencies":{"@playwright/test":"^1.28.1","@storybook/addon-a11y":"^7.6.5","@storybook/addon-essentials":"^7.6.5","@storybook/addon-interactions":"^7.6.5","@storybook/addon-links":"^7.6.5","@storybook/addon-svelte-csf":"^4.0.13","@storybook/blocks":"^7.6.5","@storybook/jest":"^0.2.3","@storybook/svelte":"^7.6.5","@storybook/sveltekit":"^7.6.5","@storybook/test":"^7.6.5","@storybook/testing-library":"^0.2.2","@sveltejs/adapter-static":"^2.0.0","@sveltejs/kit":"^1.0.0","@sveltejs/package":"^2.0.0","@sveltejs/vite-plugin-svelte":"^2.0.0","@tailwindcss/typography":"^0.5.10","@testing-library/jest-dom":"^6.1.5","@testing-library/svelte":"^4.0.5","@types/sanitize-html":"^2.9.5","@typescript-eslint/eslint-plugin":"^6.0.0","@typescript-eslint/parser":"^6.0.0","@vitest/coverage-v8":"^1.0.4","@vitest/ui":"^1.0.4","autoprefixer":"^10.4.16","eslint":"^8.28.0","eslint-config-prettier":"^9.1.0","eslint-plugin-storybook":"^0.6.15","eslint-plugin-svelte":"^2.30.0","jsdom":"^23.0.1","postcss":"^8.4.32","prettier":"^3.1.1","prettier-plugin-svelte":"^3.1.2","publint":"^0.1.9","react":"^18.2.0","react-dom":"^18.2.0","shikiji":"^0.9.9","storybook":"^7.6.5","svelte":"^4.2.7","svelte-check":"^3.6.0","tailwindcss":"^3.3.6","tslib":"^2.4.1","typescript":"^5.0.0","vite":"^4.0.0","vitest":"^1.0.4"},"svelte":"./dist/index.js","types":"./dist/index.d.ts","type":"module","dependencies":{"marked":"^11.1.0","sanitize-html":"^2.11.0"},"_id":"@dharpa/kiara-svelte-components@0.0.1","gitHead":"7217af73355f3cc859942ad04acb6585ed82b4b4","description":"This repository contains components to display data from `kiara`, and to help interacting with `kiara`. They are written in Svelte, [learn more about Svelte in their docs](https://svelte.dev/docs).","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-jqQroDmRyaEqRKhVK5Hx7G5UiUJZ8KMk0l5yyvc7DSRKkPivgavuRtl8B7gHHX0Mpu9vfe8de+6kjqdht9WwjA==","shasum":"17d30f886fe64b31d89539e27357f08992e18fe2","tarball":"https://registry.npmjs.org/@dharpa/kiara-svelte-components/-/kiara-svelte-components-0.0.1.tgz","fileCount":30,"unpackedSize":40992,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBdRZFDZbB/pgeJlNKYR5jfe3qmSBjh9HiOnnsKdnSDbAiA1dwGxufIbV8YuhQFN917YN3hY7laFLCVey3kHxbSwag=="}]},"_npmUser":{"name":"carofyi","email":"hi@caro.fyi"},"directories":{},"maintainers":[{"name":"carofyi","email":"hi@caro.fyi"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kiara-svelte-components_0.0.1_1708021951822_0.13383857259727217"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-15T18:32:31.699Z","0.0.1":"2024-02-15T18:32:31.991Z","modified":"2024-02-15T18:32:32.530Z"},"maintainers":[{"name":"carofyi","email":"hi@caro.fyi"}],"description":"This repository contains components to display data from `kiara`, and to help interacting with `kiara`. They are written in Svelte, [learn more about Svelte in their docs](https://svelte.dev/docs).","homepage":"https://github.com/DHARPA-Project/kiara-svelte-components","repository":{"type":"git","url":"git+https://github.com/DHARPA-Project/kiara-svelte-components.git"},"contributors":[{"name":"Caro Appleby","email":"hi@caro.fyi"}],"bugs":{"url":"https://github.com/DHARPA-Project/kiara-svelte-components/issues"},"license":"MPL-2.0","readme":"# [Svelte](https://svelte.dev/) components for [`kiara`](https://dharpa.org/kiara.documentation)\n\nThis repository contains components to display data from `kiara`, and to help interacting with `kiara`. They are written in Svelte, [learn more about Svelte in their docs](https://svelte.dev/docs).\n\n## Developing\n\nClone this repository using git. Install operating system dependenices [NodeJS](https://nodejs.org/) and npm, then:\n\n```bash\nnpm install  # install project dependencies, first time only\nnpm run dev\n```\n\nAlternatively, if you have the [`just`](https://github.com/casey/just) task runner installed, run `just setup`.\n\nEverything inside `src/lib` is part of the component library, everything inside `src/routes` is the showcase or preview app.\n\nOptionally (but please do if you can) there's a [pre-commit](https://pre-commit.com/) hook to check formatting before each commit. You'll need [pre-commit installed globally](https://pre-commit.com/#installation) on your machine, then run `pre-commit install` to enable the hook.\n\n## Testing\n\nThe project is set up to enable \"unit\" testing via [vitest](https://vitest.dev/), and browser/UI testing via [playwright](https://playwright.dev/). Run the tests with:\n\n```bash\nnpm run test  # all the tests\nnpm run test:integration  # just the UI tests\nnpm run test:unit  # just the unit tests\n```\n\nThere's also various linters, formatters and typescript typechecking configured. Run these:\n\n```bash\nnpm run format  # fix formatting using prettier\nnpm run lint  # check for lint errors using eslint\nnpm run check  # svelte and typescript checks\n```\n\nAll of these things will be run in [GitHub actions](https://github.com/DHARPA-Project/kiara-svelte-components/actions) when code is pushed.\n\n## Building\n\nTo build the library:\n\n```bash\nnpm run package\n```\n\nTo create a production version of the showcase app:\n\n```bash\nnpm run build\n```\n\nPreview the production build with `npm run preview`. The showcase app can be deployed anywhere you can host a static site, using [SvelteKit's adaper-static](https://kit.svelte.dev/docs/adapter-static). Deployment is not yet implemented.\n\n## Publishing\n\nThe package is published to `npm`, in the `dharpa` org account. Install it with `npm i @dharpa/kiara-svelte-components`. To publish a new version, create a release on GitHub and write some release notes. Make sure the version number in `package.json` is different to the exising published version (the GitHub Action will fail if you forgot to do this).\n\nTo use the package in another JavaScript project with Svelte support:\n\n- clone this repository to your machine,\n- run `npm build` in this repository to build the package,\n- then in your other project, run `npm install ../path/to/this-repo` to install this package as a [local path dependency](https://docs.npmjs.com/cli/v6/configuring-npm/package-json#local-paths).\n\nNote that when you want to update this package in your new project, you may need to delete your `node_modules` folder and run `npm install` again. This is to do with the build system (vite) interacting with local packages without version numbers. There may be a better solution, but this approach works sufficiently for now until publishing is implemented.\n","readmeFilename":"README.md"}