qwikdev / roadplan Goto Github PK

I'd propose instead to make scroll behaviour smooth so you still get that when clicking the links in toc.

Let's start with a basic implementation and than we can iterate on it.

I would like to release this project as a npm package usable with the npm cli
e.g. npx roadplan@latest

So these are the steps

• ask for favourite npm package manager (npm, yarn, pnpm, bun) and use it in the next steps
• ask for project name
• create a folder with that name
• copy all the roadplan repository files into it (without internal files / folders)
• install dependencies

This article could be an help but you can find a lot of article for this topic.

We need to have a RoadPlan homepage to pitch the project.

e.g. The astro one is awesome, kudos to the team 👏

The highlight should probably take up all the space in the container. The copy button also seems like it could use a bit of padding and I think people probably expect to see the copy button on the right side instead of left.

We need a logo with right colors for different use cases (light and dark mode):

• npm
• README
• website
• others

We are using this function in the code --> import.meta.glob and we have this warning in the console

The glob option "as" has been deprecated in favour of "query". Please update as: 'raw' to query: '?raw', import: 'default'

We should update the functionality with the new Vite syntax

The starter doesn't come with a .gitignore out of the box

npx command allows you to run an arbitrary command from an npm package (either one installed locally, or fetched remotely), in a similar context as running it via npm run.
Full docs here

npx @qwikdev/roadplan and bunx @qwikdev/roadplan are working fine.

we need to support other package manager too.

pnpm exec @qwikdev/roadplan
yarn create @qwikdev/roadplan

After installing a blank version of Roadplan when opening dev server I'm met with the following error stemming from the showcase component.

❗️ Expect significant performance loss in development.
  ❗️ Disabling the browser's cache results in waterfall requests.
10:12:31 PM [vite] warning: When referencing "Component" inside a different scope (useTask$), Qwik needs to serialize the value, however "Component.value" is a function, which is not serializable.
Check out https://qwik.builder.io/docs/advanced/dollar/ for more details.
  Plugin: vite-plugin-qwik
  File: src/components/Showcase/Showcase.tsx:40:7
  38 |      if (isDev) {
  39 |        componentRaw.value = await componentsRaw[snippetPath]();
  40 |        Component.value = await components[snippetPath]();
     |         ^
  41 |      } else {
  42 |        componentRaw.value = componentsRaw[snippetPath];
10:12:31 PM [vite] warning: When referencing "Component" inside a different scope (useTask$), Qwik needs to serialize the value, however "Component.value" is a function, which is not serializable.
Check out https://qwik.builder.io/docs/advanced/dollar/ for more details.
  Plugin: vite-plugin-qwik
  File: src/components/Showcase/Showcase.tsx:43:7
  41 |      } else {
  42 |        componentRaw.value = componentsRaw[snippetPath];
  43 |        Component.value = components[snippetPath];
     |         ^
  44 |      }
  45 |