aFuzzyBear / astro-component-template

A simple template for making Astro components

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Astro Component Template

This is a template meant to ease the development of components for Astro. It does so by providing you with:

  • A clear default directory structure
  • Default settings for ESLint, Prettier and EditorConfig inspired by the formatting used in the Astro project itself (also, they're typed πŸ‘€)
  • Proper TypeScript settings for working with Astro
  • Preconfigured VS Code workspace settings file with settings meant to make development cozy and nice

Hopefully, all of this together will provide you with a fun and comfortable development environnement for working on your Astro component

Don't forget: You should edit package.json with the info relevant to your project, such as a proper name, a license, a link to the repository for the npm website and other settings

Note: At the end of the day, this is only a template meant to get yourself started quickly. If you do not agree with any of the settings, naming conventions, the folder structure or anything else, you can and you should change things so things are easier and nicer for your needs and wants

Folder Structure

/
β”œβ”€β”€ .vscode/                    # VS Code settings folder
β”‚   β”œβ”€β”€ settings.json           # Workspace settings
β”‚   └── extensions.json         # Very strongly recommended extensions to install
β”œβ”€β”€ src/                        # Your component source code
β”‚   β”œβ”€β”€ Component.astro         # Example component file
β”‚   └── main.ts                 # Example source code file
└── index.ts                    # Should contain all the exports your component provide to users

ESLint, Prettier and EditorConfig settings are respectively located in the following files: .eslintrc.js, .prettierrc.js and .editorconfig at the root of this template project.

Commands

The following npm scripts are provided to lint and format your project

Command Action
npm run format Format your project using Prettier, this edits files in-place
npm run lint Lint your project using ESLint

In VS Code, you can access those commands in the Explorer in the NPM Scripts section

Frequently asked questions

Is this official?

No, Astro does not have an official template for component and other options than this one exists

Which package manage should I use?

The one you prefer! This template makes no assumption.

The only package manager related thing in this repo is that the prettier plugins has the proper configuration needed to work with pnpm (but it works with the other too, pnpm just need additional settings)

ezoic increase your site revenue

About

A simple template for making Astro components


Languages

Language:JavaScript 70.6%Language:TypeScript 25.1%Language:Astro 4.3%