Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add components and some initial documentation #3

Merged
merged 25 commits into from
Dec 7, 2024
Merged

Conversation

ollema
Copy link
Collaborator

@ollema ollema commented Dec 3, 2024

I have not ported all demos yet - wanted to get some feedback on what I have been doing so far in terms of component documentation before I tackle that

TODO

  • use repackaged package manager aware install instructions provided by @huntabyte
  • wait for @huntabyte to update the theme so that if passes APCA, if applicable
  • rework BarqodeDropzone so that is also supports uploads, making BarqodeCapture redundant
  • port remaining demos

Copy link

changeset-bot bot commented Dec 3, 2024

🦋 Changeset detected

Latest commit: 4ab63cd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
barqode Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 3, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
barqode ✅ Ready (View Log) Visit Preview 11e59d2

@ollema ollema requested a review from huntabyte December 3, 2024 11:48
@huntabyte
Copy link
Member

Let's make the file names kebab-case for the content and such!

@huntabyte
Copy link
Member

Now that I've had time to think about it, that package manager component will be a low priority for Svecosystem since most of these packages are only installed once. We'll use the standard npm/npx where we need to for now; perhaps we can get fancier with it in the future.

Most people using alt package managers understand how to map np* to their respective PM.

@ollema
Copy link
Collaborator Author

ollema commented Dec 5, 2024

Now that I've had time to think about it, that package manager component will be a low priority for Svecosystem since most of these packages are only installed once. We'll use the standard npm/npx where we need to for now; perhaps we can get fancier with it in the future.

Most people using alt package managers understand how to map np* to their respective PM.

makes sense! marked that one as done in the TODO list

@huntabyte
Copy link
Member

We can update @svecodocs/kit to latest in the docs package to get the latest theme and check another thing off the list :)

@ollema
Copy link
Collaborator Author

ollema commented Dec 5, 2024

We can update @svecodocs/kit to latest in the docs package to get the latest theme and check another thing off the list :)

will fix!

@ollema
Copy link
Collaborator Author

ollema commented Dec 5, 2024

well I'm not sure what's wrong but I am not able to build the docs locally anymore.

have to leave now for travel but will take a look tomorrow evening unless someone else can look into it by then

pnpm build

> @barqode/[email protected] build /Users/s0001325/repos/barqode/docs
> velite && node ./scripts/update-velite-output.js && pnpm build:search && vite build

[VELITE] build finished in 179.78ms

> @barqode/[email protected] build:search /Users/s0001325/repos/barqode/docs
> node ./scripts/build-search-data.js

(node:36216) ExperimentalWarning: Importing JSON modules is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
vite v6.0.3 building SSR bundle for production...
✓ 589 modules transformed.
x Build failed in 2.26s
error during build:
[vite-plugin-svelte] [plugin vite-plugin-svelte] src/lib/components/blueprint.svelte (2:9): src/lib/components/blueprint.svelte:2:9 `a` is not defined
file: /Users/s0001325/repos/barqode/docs/src/lib/components/blueprint.svelte:2:9

 1 |  <script lang="ts" module>// prettier-ignore
 2 |  export { a, blockquote, code, h1, h2, h3, h4, h5, h6, hr, img, li, ol, p, pre, table, td, th, tr, ul } from '@svecodocs/kit';
                ^
 3 |  </script>
 4 |  


 ELIFECYCLE  Command failed with exit code 1.
/Users/s0001325/repos/barqode/docs/src/lib/components/blueprint.svelte
  3:11  error  `a` is not defined(export_undefined)  svelte/valid-compile

Copy link
Member

@huntabyte huntabyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will make this more robust via restProps/refs in a future release

@ollema ollema merged commit 5d381e4 into main Dec 7, 2024
5 checks passed
@huntabyte huntabyte deleted the getting-started branch December 12, 2024 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants