42 | ```
43 |
44 | ## In an Astro _component_
45 |
46 |
47 | ```astro
48 | ---
49 | import { type Robot } from '/content';
50 |
51 | // Augment your `Props`
52 | const { feats } = Astro.props as { feats: Robot };
53 | ---
54 |
55 |
56 |
57 |
58 |
59 | {feats?.meta?.price}
60 |
61 | ```
62 |
--------------------------------------------------------------------------------
/docs/content/docs/install/main.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Installation
3 | order: 2
4 | ---
5 |
6 | ## Method 1: Add to Astro project with _CLI_
7 |
8 | With `yarn`, `npm` or `pnpm`, run this in your **existing** Astro project:
9 |
10 | ```sh
11 | # If you want a fresh start ——v
12 | # pnpm create astro && cd ./my-astro-site
13 |
14 | pnpm astro add astro-content
15 | pnpm content setup
16 | ```
17 |
18 | Follow the prompts… 🐇
19 |
20 | ## Method 2: Clone _demo project_
21 |
22 | Shallow **clone** this minimal Astro **starter**, which comes with dummy **content** for you to play with:
23 |
24 | ```sh
25 | pnpx degit JulianCataldo/astro-content/demo ./ac-demo
26 | cd ./ac-demo && pnpm install
27 |
28 | # Clone dummy content
29 | pnpx degit JulianCataldo/astro-content/docs/content/@dummy ./content
30 | # —OR— setup a minimal content base with Astro Content CLI
31 | pnpm content setup
32 |
33 | # Open project in VS Code
34 | code .
35 | ```
36 |
37 | > **Warning**: Only **Node 17** or higher is actually supported by Astro Content.
38 |
39 | ## _Launch_ project
40 |
41 | OK, **project is ready**. It's time to:
42 |
43 | ```sh
44 | pnpm run dev
45 | ```
46 |
47 | Now head over to [http://localhost:3000/**\_\_content**](http://localhost:9054/__content) to take a deep dive in Astro Content.
48 |
49 | ## _TypeScript_ setup
50 |
51 | It's OK to use an absolute path, so you don't have to do tedious relative imports:
52 |
53 | ```tsx
54 | import { get } from '../../content';
55 | // Versus:
56 | import { get } from '/content';
57 | ```
58 |
59 | Astro / Vite resolve absolute paths from project root.
60 | That's cool,
61 | but TypeScript language server (in your IDE) will likely break, while showing
62 | red squiggles 🤨.
63 |
64 | A very simple fix is adding this to your `tsconfig.json` > `compilerOptions.paths`:
65 |
66 | ```jsonc
67 | {
68 | "compilerOptions": {
69 | // …
70 | "paths": {
71 | // Make TS happy with absolute path
72 | "/content": ["./content"]
73 | }
74 | }
75 | }
76 | ```
77 |
--------------------------------------------------------------------------------
/docs/content/docs/intro/main.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Introduction
3 | order: 1
4 | ---
5 |
6 | ## What is it?
7 |
8 | Think of it as an hybrid of **Wordpress** + ACF, **Obsidian** and **Ulysses**, with a sprinkle of **tRPC** and **nuxt/content**.
9 |
10 | ## What it does?
11 |
12 | ✨ Adds a thin layer between Astro and your templates, bringing automatic **typings**, runtime validation and a handful of **DX** goodies.
13 |
14 | 🏗 Brings evolved authoring assistance, in a **full-fledged** back-office, inside your **IDE** or with **CLI**, as you prefer.
15 |
16 | ## Main goals
17 |
18 | Being content centric, this set of tools will give you:
19 |
20 | - **Focus** when designing 👌
21 | - **Confidence** when authoring ✍️
22 | - **Predictability** when integrating 🤝
23 | - **Certainty** while delivering 💪
24 | - **Peace** of mind when refactoring 👍
25 |
26 | ---
27 |
28 | > **Warning**: This is an **`alpha`** product — Heavy changes are on-going — [Suggestions are welcome 👐](https://github.com/JulianCataldo/astro-content/issues)
29 |
--------------------------------------------------------------------------------
/docs/content/docs/more/main.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Tell me more
3 | order: 8
4 | ---
5 |
6 | # Tell me more
7 |
8 | ## Why this project?
9 |
10 | It's either an **I**ntegrated **A**uthoring **E**nvironment as its targeting tech-savvy people (not necessarily developers, but also people who work with them).
11 | You could compare it to a good old top-down **CMS** (as opposed to headless): it gives you the **_head_** (Astro) and the **_spine_** (content structure + management) back.
12 | Authoring and previewing living content in the same place has its advantages,
13 | this is the case for **LAMP** stacks which has handled this for ages.
14 |
15 | Astro + Content gives this power back,
16 | without all the complexities, oddities and maintenance burden of traditional CMSs (with all due respect).
17 | Opting for this symbiose between _code_ and _content_ has took a big leap,
18 | thanks to headless, "JAMStack" frameworks which popularize
19 | **Markdown** and **MDX** as a first class citizen, with a whole set of eco-systems around these.
20 | For example, Astro Content makes validating Markdown _front matter_ part of its core. Though still far from perfect, every step like this one
21 | is done to catch up a bit with high standards developer experience (e.g. TypeScript).
22 |
23 | Tooling has still a lot of room to grow for MD(X), and things are a bit scattered in these areas. In fact, some of them are in their infancy.
24 | That's what motivated Astro Content: easing environment setup and usage.
25 | The more people use these tools, the more incentive these will get to be improved.
26 |
--------------------------------------------------------------------------------
/docs/content/docs/reports/main.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Reports
3 | order: 6
4 | ---
5 |
6 | # Reports
7 |
8 | You can benefit from these three levels of content checks:
9 |
10 | 1. **Schema** structure
11 | 2. File **language syntax** linting
12 | 3. **Natural language** linting
13 |
--------------------------------------------------------------------------------
/docs/content/docs/tips/no_main.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Tips
3 | order: 7
4 | ---
5 |
--------------------------------------------------------------------------------
/docs/content/docs/work-in-progress/main.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Roadmap
3 | order: 8
4 | ---
5 |
6 | # Work in progress
7 |
8 |
9 |
10 | — Scopes: [ **int** · **srv** · **gui** · **ide** · **gui** · **cli** · **doc** ] —
11 |
12 |
13 |
14 | ---
15 |
16 | - [ ] Rehaul Astro `MarkdownInstance` <=> `MardownFile` schema definition <=> `MarkdownFile` TS interface. [ **int** · **srv** ]
17 | - [ ] `Content` Astro component especially, is not propertly typed.
18 | - [ ] Same for `YamlInstance`, which need some love, generally.
19 | - [ ] Actual runtime JSON Schema validation, not just _reporting_ errors, but pro-actively preventing them to occur, with opt-out capabilities. [ **srv** ]
20 | - [ ] Automatic remark-lint setup. [ **srv** · **ide** · **cli** ]
21 | - [ ] Automatic remark sync. [ **srv** · **ide** · **cli** ]
22 | - [ ] Custom Markdown linting rules -> Should hook up with `.remarkrc.mjs`, so user benefit from both IDE and Web app custom rules. [ **srv** · **ide** ]
23 | - [ ] Add documentation to website [ **doc** ]
24 | - [ ] Fix silent MDX failures breaking entire app. [ **int** · **srv** · **gui** ]
25 | - [ ] MDX support [ **gui** ]
26 | - [x] Syntax highlighting + configuration for monaco.
27 | - [ ] Advanced language features.
28 | - [ ] Syntax highlight for MD front matters [ **gui** ]
29 |
--------------------------------------------------------------------------------
/docs/content/globals/global.schema.yaml:
--------------------------------------------------------------------------------
1 | properties:
2 | menu:
3 | type: array
4 | items:
5 | - properties:
6 | title:
7 | type: string
8 | href:
9 | type: string
10 |
11 | notes: {}
12 |
13 | required:
14 | - website
15 | # - notes
16 |
--------------------------------------------------------------------------------
/docs/content/globals/website/menu.yaml:
--------------------------------------------------------------------------------
1 | - title: Astro Content
2 | href: /
3 | - title: Astro Content
4 | href: /
5 |
--------------------------------------------------------------------------------
/docs/content/modules/cli-or-gui/text.md:
--------------------------------------------------------------------------------
1 | # You get the command line, with a graphical interface, for free
2 |
3 | Initially designed as a 100% CLI tool, Astro Content seeks feature parity
4 | between the CLI and the GUI.
5 |
6 |
8 |
9 |
10 |
11 | ## Separation of concern
12 |
13 | ### Multiple monitor, multiple workbenchs
14 |
15 | one for your template / business logic
16 | one for content edition
17 |
18 | ### Ressources splitting
19 |
20 | VS Code use a lot of ressources for TypeScript, languages servers and your
21 | bazillions of extensions.
22 | Adding schema, linting
23 |
--------------------------------------------------------------------------------
/docs/content/modules/credits/text.md:
--------------------------------------------------------------------------------
1 | # Hey
2 |
3 | Some
4 |
--------------------------------------------------------------------------------
/docs/content/modules/features/text.mdx:
--------------------------------------------------------------------------------
1 | import { Picture } from '@astrojs/image/components';
2 |
3 | import astro from '/src/assets/features.svg?raw';
4 |
5 |
6 |
7 |
18 |
19 |
20 | Create content
21 | with _confidence_.
22 |
23 |
24 |
12 |
13 | # Similar / inspired by
14 |
15 | - **Gatsby**, Nuxt, Gridsome
16 | - **tRPC**, **GraphQL**, Mongo API
17 | - **nuxt/content**, Docus, **Contentlayer**
18 | - Dendron, **Obsidian**, Ulysses
19 | - **Strapi**, Postman, VS Code
20 |
21 |
22 |
23 |
32 |
--------------------------------------------------------------------------------
/docs/content/modules/landing/text.md:
--------------------------------------------------------------------------------
1 | # Astro Content — (_Preview_)
2 |
3 | A text based, structured content framework,
4 | with a focus on **editor** and **integrator** experience.
5 |
6 | ---
7 |
8 | ## 🏗 Structure
9 |
10 | - Check for **schema**, **syntax**, and **prose** mistakes.
11 | - Edit schemas: get content-wide, instant **refactoring** guidance and **mockup** data to play with.
12 | - **Prevent entropy** for ever growing knowledge bases.
13 |
14 |
15 | ## 💈 Author
16 |
17 | - Use state of the art Markdown processing engine,
18 | with a **rich** and **extensible** plugin ecosystem.
19 | - **Live preview**, rich render. As close as final output can get.
20 | - Gives to content team a **pre-configured**,
21 | **predictable** editing environment.
22 |
23 | ## 🛎 Provide
24 |
25 | - Generate type-safe **import helpers**.
26 | - **Future-proof**: seeks standards, idioms and popular tools.
27 | - **Agnostic** API: target any consumer type.
28 |
29 | ---
30 |
31 | ### Uses cases
32 |
33 | Wiki, documentation, web gardens, personal, blog, news, components storybooks…
34 |
35 | For **private** / **public**, **corporate** / **personal** use.
36 | You could really make Astro Content anything you want!
37 |
38 | It's now possible to engage **large content refactors** with an eagle view,
39 | without **complicated toolings** setup and **vendor lock-in**.
40 |
--------------------------------------------------------------------------------
/docs/content/modules/module.schema.yaml:
--------------------------------------------------------------------------------
1 | properties:
2 | gallery:
3 | properties:
4 | source:
5 | type: string
6 | required:
7 | - source
8 |
9 | text: {}
10 |
11 | relations: {}
12 |
13 | install:
14 | properties:
15 | foo:
16 | type: string
17 | bar:
18 | type: string
19 | required:
20 | - foo
21 | - bar
22 |
23 | required:
24 | - text
25 | # - gallery
26 |
--------------------------------------------------------------------------------
/docs/content/pages/home/main.mdx:
--------------------------------------------------------------------------------
1 | # Hey
2 |
--------------------------------------------------------------------------------
/docs/content/pages/page.schema.yaml:
--------------------------------------------------------------------------------
1 | properties:
2 | main:
3 | properties:
4 | title:
5 | type: string
6 | order:
7 | type: number
8 |
9 | required:
10 | - main
11 |
--------------------------------------------------------------------------------
/docs/env.d.ts:
--------------------------------------------------------------------------------
1 | // declare module '*.module.css';
2 | // declare module '*.module.scss';
3 | // // and so on for whatever flavor of css you're using
4 |
--------------------------------------------------------------------------------
/docs/public/favicon.svg:
--------------------------------------------------------------------------------
1 |
12 |
--------------------------------------------------------------------------------
/docs/public/poster.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/JulianCataldo/astro-content/d5ed86fcc9ae27cede28ebcedabaaf39a45ae613/docs/public/poster.png
--------------------------------------------------------------------------------
/docs/src/app/Footer.astro:
--------------------------------------------------------------------------------
1 | ---
2 | import { Link } from 'astro-link';
3 | import guiOverlay from '../assets/separator.svg?raw';
4 | // import github from '../assets/github.svg?raw';
5 | import './Footer.scss';
6 | ---
7 |
8 |
40 |
--------------------------------------------------------------------------------
/docs/src/app/Footer.scss:
--------------------------------------------------------------------------------
1 | @use 'sass:color';
2 | @use '../vars' as *;
3 |
4 | .app-footer {
5 | display: flex;
6 | flex-wrap: wrap;
7 | align-items: flex-end;
8 | justify-content: flex-start;
9 | padding: 10rem 5rem 2rem 2rem;
10 | font-family: $font-fancy;
11 | font-style: italic;
12 |
13 | .separator {
14 | width: 30vw;
15 | margin-right: 2vw;
16 | opacity: 0.8;
17 | }
18 |
19 | .star-me {
20 | align-self: flex-start;
21 |
22 | svg {
23 | height: 0.7em;
24 | }
25 |
26 | font-size: 1.5em;
27 | }
28 |
29 | .btt {
30 | a {
31 | display: block;
32 | padding: 1rem;
33 | }
34 | }
35 |
36 | .built-with {
37 | display: flex;
38 | align-items: center;
39 | justify-content: center;
40 | margin-right: 2rem;
41 |
42 | & > * {
43 | display: flex;
44 | align-items: center;
45 | }
46 |
47 | a {
48 | padding: 0 1rem;
49 | }
50 |
51 | margin-left: auto;
52 | text-align: right;
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/docs/src/app/LazyLoading.astro:
--------------------------------------------------------------------------------
1 | ---
2 | // Quick hack 🏴☠️
3 | ---
4 |
5 |
19 |
20 |
29 |
--------------------------------------------------------------------------------
/docs/src/app/NavigationBar.astro:
--------------------------------------------------------------------------------
1 | ---
2 | import { Link } from 'astro-link';
3 | import './NavigationBar.scss';
4 | import logo from '../assets/astro-content-logo.svg?raw';
5 | import brain from '../assets/brain-circuit-20-filled.svg?raw';
6 | import github from '../assets/github.svg?raw';
7 | import discord from '../assets/discord.svg?raw';
8 | import controller from '../assets/game-controller-sharp.svg?raw';
9 |
10 | const current = Astro.url.pathname.split('/')[1] || 'home';
11 | ---
12 |
13 |
66 |
--------------------------------------------------------------------------------
/docs/src/app/NavigationBar.scss:
--------------------------------------------------------------------------------
1 | @use 'sass:color';
2 | @use '../vars' as *;
3 |
4 | .component-navigation-bar {
5 | @media screen and (max-width: 700px) {
6 | margin-bottom: 4rem;
7 | }
8 |
9 | ul {
10 | display: flex;
11 | flex-wrap: wrap;
12 | align-items: flex-start;
13 | justify-content: flex-end;
14 | padding: 1rem 4rem;
15 | list-style-type: none;
16 |
17 | li:first-of-type {
18 | min-width: 34vw;
19 | @media screen and (max-width: 700px) {
20 | margin-bottom: 4rem;
21 | }
22 | }
23 |
24 | a {
25 | display: flex;
26 | align-items: center;
27 | padding: 0 2.5vw;
28 | padding: 0.7rem 1.5vw;
29 | margin: 1vw;
30 | font-family: $font-fancy;
31 | font-size: 1.3334em;
32 | font-style: italic;
33 | font-weight: 500;
34 | font-weight: 900;
35 | color: white;
36 | border-bottom: 2px solid color.adjust($ca-main-5, $alpha: -0.6);
37 | border-radius: 1rem;
38 |
39 | &:hover {
40 | color: $ca-accent;
41 | }
42 |
43 | &:active {
44 | transform: translateY(1.5px);
45 | }
46 | }
47 |
48 | .home {
49 | margin-right: auto;
50 | }
51 |
52 | .btn {
53 | }
54 |
55 | .btn.active a,
56 | a:active {
57 | border-bottom: 2px solid color.adjust($ca-accent, $alpha: -0.5);
58 | border-radius: 1rem;
59 | }
60 | }
61 |
62 | .logo {
63 | display: inline-block;
64 | width: 14rem;
65 | height: 6rem;
66 | padding: 0 1rem;
67 |
68 | &:hover {
69 | filter: drop-shadow(1px 1px 3px $ca-accent);
70 | }
71 | }
72 |
73 | .icon {
74 | width: 1.7em;
75 | height: 1.7em;
76 | padding: 0.2em;
77 |
78 | &.enlarge {
79 | width: 1.8em;
80 | height: 1.8em;
81 | padding: 0.11em;
82 | // padding-bottom: 0em;
83 | }
84 |
85 | margin-right: 1rem;
86 | margin-right: 1em;
87 |
88 | svg {
89 | width: 100%;
90 | height: 100%;
91 | }
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/docs/src/assets/brain-circuit-20-filled.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/assets/discord.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/assets/game-controller-sharp.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/assets/github.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/assets/logos/mdx-logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/assets/logos/ts-logo-round.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/assets/logos/vite.svg:
--------------------------------------------------------------------------------
1 |
16 |
--------------------------------------------------------------------------------
/docs/src/assets/logos/yaml.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/docs/src/assets/shape-1.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/docs/src/assets/terminal.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/src/components-demo/Button.tsx:
--------------------------------------------------------------------------------
1 | interface Props {
2 | variant: 'fancy' | 'default';
3 | /** Wow */
4 | hello: {
5 | test: string;
6 | testAaa: number;
7 | };
8 | }
9 |
10 | export default function Button({ children }: Props) {
11 | return (
12 |
16 | );
17 | }
18 |
--------------------------------------------------------------------------------
/docs/src/components-demo/Crab.astro:
--------------------------------------------------------------------------------
1 | ---
2 | interface Arthropoda {
3 | foo?: string;
4 | }
5 |
6 | /**
7 | * **Crab main features**: `antennas`, `abdomen`
8 | */
9 | interface Props extends astroHTML.JSX.HTMLAttributes, Arthropoda {
10 | /** Will it bite? `Maybe` */
11 | character?: string;
12 |
13 | /**
14 | * [_Crabology_](http://example.com/crab) code example:
15 | *
16 | * ```js
17 | * console.log('Crab mode — ON')
18 | * ````
19 | */
20 | shellColor: 'salmon' | 'seashell' | 'seagreen' | 'transparent';
21 |
22 | /** From **1** to **10** */
23 | clawsSize: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
24 | }
25 | const {
26 | character = 'gentle',
27 | shellColor = 'seashell',
28 | clawsSize = 5,
29 | } = Astro.props as Props;
30 | ---
31 |
32 |
33 |
34 | the 🦀 <Crab /> dummy component 🌊
35 |
36 |
37 |
38 | - Character: {character}
39 | - Shell color: {shellColor}
40 | - Claws size:
41 |
42 |
43 |
44 |
49 |
50 |
51 | Crabs are generally covered with a thick exoskeleton, composed primarily of
52 | highly mineralized chitin.
53 |
54 |
35 |
36 | From: 📄
{file}
37 |
38 |
39 |
40 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
30 |
31 |
35 |
36 |
20 |
21 |
Sections
22 |
23 |
24 |
25 |
26 |
On this page
27 |
28 |
29 |
14 | {title}
15 | →
16 |
17 |
18 | {body}
19 |
20 |
21 |
22 |
63 |
--------------------------------------------------------------------------------
/packages/faker/demo/src/env.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 |
--------------------------------------------------------------------------------
/packages/faker/demo/src/layouts/Layout.astro:
--------------------------------------------------------------------------------
1 | ---
2 | export interface Props {
3 | title: string;
4 | }
5 |
6 | const { title } = Astro.props;
7 | ---
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | {title}
17 |
18 |
19 |
20 |
21 |
22 |
36 |
--------------------------------------------------------------------------------
/packages/faker/demo/src/mocks/blog-post.template.md:
--------------------------------------------------------------------------------
1 | ---
2 | '$schema': src/schemas/blog-post.schema.yaml
3 | ---
4 |
5 | ```js:faker
6 | '# ' + faker.lorem.sentence(10)
7 | ```
8 |
9 | ```js:faker
10 | '## ' + faker.lorem.sentence(9)
11 | ```
12 |
13 | ```js:faker
14 | `**${faker.address.city()}**`
15 | ```
16 |
17 | ```js:faker
18 | faker.lorem.sentence(12)
19 | ```
20 |
21 | ```js:faker
22 | '### ' + faker.lorem.sentence(9)
23 | ```
24 |
25 | ```js:faker
26 | ``
27 | ```
28 |
29 | ---
30 |
31 | ```js:faker
32 | '> ' + faker.lorem.sentence(10)
33 | ```
34 |
35 | ---
36 |
37 | ```js:faker
38 | `- ${faker.lorem.sentence(6)}\n- ${faker.lorem.sentence(8)}\n- ${faker.lorem.sentence(10)}`
39 | ```
40 |
41 | ```js:faker
42 | ``
43 | ```
44 |
45 | ```js:faker
46 | '## ' + faker.lorem.sentence(9)
47 | ```
48 |
49 | ```js:faker
50 | faker.lorem.paragraphs(2)
51 | ```
52 |
53 | ```js:faker
54 | '### ' + faker.lorem.sentence(9)
55 | ```
56 |
57 | ```js:faker
58 | ``
59 | ```
60 |
61 | ```js:faker
62 | faker.lorem.paragraphs(1)
63 | ```
64 |
65 | ---
66 |
67 | ```js:faker
68 | faker.date.recent().toLocaleDateString()
69 | ```
70 |
--------------------------------------------------------------------------------
/packages/faker/demo/src/schemas/blog-post.schema.yaml:
--------------------------------------------------------------------------------
1 | title: Blog post
2 |
3 | allOf:
4 | - $ref: ./tags.schema.yaml
5 |
6 | - properties:
7 | title:
8 | title: Title
9 | default: My untitled blog post
10 | description: Used for SEO and tab title! # Will appear in auto-completion
11 | type: string
12 | minLength: 1
13 | maxLength: 80
14 |
15 | description:
16 | title: Description
17 | default: No description found.
18 | description: Used for SEO
19 | type: string
20 | minLength: 100
21 | maxLength: 300
22 |
23 | required:
24 | - title
25 | - description
26 |
--------------------------------------------------------------------------------
/packages/faker/demo/src/schemas/tags.schema.yaml:
--------------------------------------------------------------------------------
1 | description: |
2 | Used for content classification
3 |
4 | properties:
5 | tags:
6 | type: array
7 | uniqueItems: true
8 | minItems: 1
9 | maxItems: 8
10 | items:
11 | type: string
12 | enum:
13 | - Music
14 | - Video
15 | - Development
16 | - Cooking
17 | - Gardening
18 | - Sport
19 |
--------------------------------------------------------------------------------
/packages/faker/demo/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "astro/tsconfigs/base",
3 | "base": "."
4 | }
5 |
--------------------------------------------------------------------------------
/packages/faker/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@astro-content/faker",
3 | "version": "0.0.0-alpha.16",
4 | "description": "",
5 | "keywords": [
6 | "astro",
7 | "astro-integration",
8 | "json-schema",
9 | "faker",
10 | "frontmatter",
11 | "markdown"
12 | ],
13 | "homepage": "https://astro-content.dev",
14 | "repository": {
15 | "type": "git",
16 | "url": "https://github.com/JulianCataldo/astro-content",
17 | "directory": "packages/faker"
18 | },
19 | "license": "ISC",
20 | "author": "Julian Cataldo",
21 | "type": "module",
22 | "main": "./dist/index.js",
23 | "bin": {
24 | "content-faker": "./dist/cli.js"
25 | },
26 | "files": [
27 | "dist/*"
28 | ],
29 | "scripts": {
30 | "build": "tsc",
31 | "clean": "rm -rf dist .turbo",
32 | "dev": "tsc -w",
33 | "test": "echo \"Error: no test specified\" && exit 1"
34 | },
35 | "dependencies": {
36 | "@apidevtools/json-schema-ref-parser": "^9.0.9",
37 | "@faker-js/faker": "^7.6.0",
38 | "json-schema-faker": "0.5.0-rcv.46",
39 | "yaml": "^2.1.3"
40 | },
41 | "devDependencies": {
42 | "typescript": "^4.8.4"
43 | },
44 | "publishConfig": {
45 | "access": "public"
46 | },
47 | "// source": "./index.ts"
48 | }
49 |
--------------------------------------------------------------------------------
/packages/faker/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "ESNext",
4 | "module": "ESNext",
5 |
6 | "moduleResolution": "node",
7 | // Enable JSON imports.
8 | "resolveJsonModule": true,
9 |
10 | "isolatedModules": true,
11 |
12 | "types": ["node"],
13 |
14 | "baseUrl": ".",
15 |
16 | "allowSyntheticDefaultImports": true,
17 |
18 | "noImplicitAny": true,
19 |
20 | "strictNullChecks": true,
21 |
22 | "importsNotUsedAsValues": "error",
23 |
24 | "declaration": true,
25 |
26 | "outDir": "./dist"
27 | },
28 |
29 | "include": ["./index.ts", "./cli.ts"]
30 | }
31 |
--------------------------------------------------------------------------------
/packages/gui/components/App/keyboard-shortcuts.ts:
--------------------------------------------------------------------------------
1 | import { useEffect } from 'react';
2 | /* ·········································································· */
3 | import { log } from '../../logger';
4 | import { useAppStore } from '../../store';
5 | /* —————————————————————————————————————————————————————————————————————————— */
6 |
7 | export function useKeyBoardShortcuts() {
8 | const save = useAppStore((state) => state.editor_save);
9 | useEffect(() => {
10 | /* Save — Keyboard shortcut */
11 | function handleAction(e: KeyboardEvent) {
12 | const metaKey = e.metaKey || e.ctrlKey;
13 | if (e.key === 's' && metaKey) {
14 | e.preventDefault();
15 | save();
16 | log('Keyboard: CtrlCmd+S fired!');
17 | }
18 | // // if (e.key === 'p' && metaKey) {
19 | // // e.preventDefault();
20 | // // showCommandPalette();
21 | // // log('Keyboard: Meta+P fired!');
22 | // // }
23 | // if (e.key === '/' && metaKey) {
24 | // // e.preventDefault();
25 |
26 | // log('Keyboard: CtrlCmd+/ fired!');
27 | // return false;
28 | // }
29 | return false;
30 | }
31 |
32 | document.addEventListener('keydown', handleAction);
33 | return () => {
34 | document.removeEventListener('keydown', handleAction);
35 | };
36 | });
37 | }
38 |
--------------------------------------------------------------------------------
/packages/gui/components/App/state-loader.ts:
--------------------------------------------------------------------------------
1 | import { useEffect, useState } from 'react';
2 | /* —————————————————————————————————————————————————————————————————————————— */
3 | import { useAppStore } from '../../store';
4 | import { log } from '../../logger';
5 | /* ··················../../logger··············································· */
6 |
7 | export function stateLoader() {
8 | // const data = useAppStore((state) => state.data_server);
9 | const [change, setChange] = useState(Math.random());
10 |
11 | useEffect(() => {
12 | // const socket = new WebSocket('ws://localhost:5011');
13 | // // Connection opened
14 | // socket.addEventListener('open', (event) => {
15 | // socket.send('Hello Server!');
16 | // });
17 | // // Listen for messages
18 | // socket.addEventListener('message', (event) => {
19 | // log(['Message from server ', event.data]);
20 | // setTimestamp(new Date());
21 | // });
22 | }, []);
23 |
24 | const fetchData = useAppStore((state) => state.data_fetchServerData);
25 | // NOTE: This is a work in progress
26 | if (import.meta.hot) {
27 | import.meta.hot.on('vite:beforeFullReload', () => {
28 | throw '(skipping full reload)';
29 | });
30 | }
31 |
32 | // useEffect(() => {
33 | // setInterval(() => {
34 | // setChange(Math.random());
35 | // }, 4500);
36 | // }, []);
37 |
38 | // FIXME: Not picking up changes
39 | useEffect(() => {
40 | fetchData()
41 | .then((e) => log(e))
42 | .catch((e) => log(e));
43 | }, [change]);
44 | // timestamp
45 |
46 | const fetchSavedUiState = useAppStore((state) => state.ui_fetchSaved);
47 |
48 | useEffect(() => {
49 | fetchSavedUiState();
50 | }, []);
51 |
52 | // return null;
53 | }
54 |
--------------------------------------------------------------------------------
/packages/gui/components/Assistant.scss:
--------------------------------------------------------------------------------
1 | @use 'sass:color' as color;
2 |
3 | .component-assistant {
4 | // width: calc(100% - 0.1rem);
5 | width: 100%;
6 | height: 100%;
7 | height: calc(100% - 3rem);
8 |
9 | img {
10 | max-width: 100%;
11 | }
12 |
13 | // NOTE: In-document rendering is disabled.
14 | // .markdown,
15 | .meta {
16 | height: 100%;
17 | padding: 0.5rem 2rem 2rem 2rem;
18 | overflow-y: auto;
19 | }
20 |
21 | .markdown {
22 | // width: 100%;
23 |
24 | iframe {
25 | width: 100%;
26 | height: 100%;
27 | padding: 0;
28 | margin: 0;
29 | }
30 | }
31 |
32 | & > * {
33 | height: 100%;
34 | }
35 | // .panes {
36 | // }
37 | }
38 |
--------------------------------------------------------------------------------
/packages/gui/components/CommandPalette.tsx:
--------------------------------------------------------------------------------
1 | // NOTE: WORK IN PROGRESS
2 |
3 | // const commandPaletteVisibility = useAppStore(
4 | // (state) => state.ui_commandPaletteVisibility,
5 | // );
6 | // const showCommandPalette = useAppStore(
7 | // (state) => state.ui_showCommandPalette,
8 | // );
9 |
10 | // {
11 | /* (
13 | <>
14 | This is a dialog!
15 |
16 | Now that we've got your attention, you can close this.
17 |
18 |
19 |
20 | )}
21 | open={commandPaletteVisibility}
22 | >
23 |
24 |
25 |
26 | */
27 | // }
28 |
--------------------------------------------------------------------------------
/packages/gui/components/CopyInlineCode.scss:
--------------------------------------------------------------------------------
1 | .component-copy-inline-code {
2 | position: relative;
3 | font-weight: 700;
4 | cursor: pointer;
5 |
6 | .prefix {
7 | user-select: none;
8 | }
9 |
10 | .overlay {
11 | position: absolute;
12 | display: flex;
13 | align-items: center;
14 | justify-content: center;
15 | width: 100%;
16 | height: 100%;
17 | background: var(--vscode-breadcrumb-background);
18 | border-radius: 0.15rem;
19 | opacity: 0;
20 |
21 | &.visible {
22 | opacity: 1;
23 | }
24 | }
25 |
26 | pre {
27 | code {
28 | display: inline-block;
29 | width: calc(100% - 1rem);
30 | padding: 0.5rem;
31 | cursor: pointer;
32 | background: var(--vscode-breadcrumb-background);
33 | border-radius: 0.15rem;
34 | }
35 | }
36 |
37 | &:hover {
38 | code {
39 | background: var(--vscode-toolbar-activeBackground);
40 | }
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/packages/gui/components/CopyInlineCode.tsx:
--------------------------------------------------------------------------------
1 | import type { Placement } from '@floating-ui/react-dom-interactions';
2 | import cx from 'classnames';
3 | import { useState } from 'react';
4 | // import Tooltip from './Tooltip';
5 | // import './CopyInlineCode.scss';
6 |
7 | interface Props {
8 | text: string;
9 | placement?: Placement;
10 | }
11 | export default function CopyInlineCode({ text, placement }: Props) {
12 | const [visible, setVisible] = useState(false);
13 |
14 | const copy = () => {
15 | navigator.clipboard
16 | .writeText(text)
17 | .then(() => {
18 | setVisible(true);
19 | setTimeout(() => setVisible(false), 1500);
20 | })
21 | .catch(() => null);
22 | };
23 |
24 | return (
25 | // TODO: Make a Tooltip hover group
26 | //
27 |
34 |
Copied to clipboard
35 |
36 | >
37 | {text}
38 |
39 |
25 | {prop &&
}
26 | {/* Schema Editor */}
27 |
28 | {entity && !entry && content[entity] && (
29 |
30 | )}
31 |
32 | {entity && !content[entity] && (
33 |
34 | ← Please select a schema (entity) or a{' '}
35 | property (file)…
36 |
37 | )}
38 |
30 | {/*
*/}
31 | {Object.entries(tabs).map(([index, tab]) => (
32 | // FIXME: JSX A11y
33 | // eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions
34 |
switchPane(index)}
42 | >
43 | {tab.icon && }
44 |
45 | {tab.title}
46 |
47 | ))}
48 | {/*
*/}
49 |
48 |
49 |
50 | Hello from
51 | ${title}
52 |
53 |
54 |
29 |
30 | ![]()
31 |
32 |
33 |
34 |
37 |
38 |
41 |
--------------------------------------------------------------------------------
/packages/imagekit/Image.client.ts:
--------------------------------------------------------------------------------
1 | import { attributes } from './Image.Props.js';
2 |
3 | const imgElems = document.querySelectorAll(`picture[${attributes.hasJs}] img`);
4 |
5 | imgElems.forEach((img) => {
6 | if (!(img instanceof HTMLImageElement)) return;
7 |
8 | function toggle() {
9 | img.toggleAttribute(attributes.isLoaded);
10 | }
11 | if (img.complete) {
12 | /* Already loaded (in cache or very fast…) */
13 | toggle();
14 | } else {
15 | img.addEventListener('load', () => toggle());
16 | }
17 | });
18 |
19 | export {};
20 |
--------------------------------------------------------------------------------
/packages/imagekit/Image.css:
--------------------------------------------------------------------------------
1 | /* Overlay the placeholder */
2 | picture[data-is-lazy] {
3 | position: relative;
4 | width: var(--width);
5 | height: var(--height);
6 | }
7 |
8 | picture[data-is-lazy] img {
9 | display: block;
10 | width: var(--width);
11 | height: var(--height);
12 | /* object-fit: cover; */
13 | }
14 |
15 | /* No JavaScript */
16 | picture > img:nth-of-type(1),
17 | picture > img:nth-of-type(2) {
18 | display: none;
19 | }
20 |
21 | /* With JavaScript */
22 | picture[data-has-js] > img:nth-of-type(1),
23 | picture[data-has-js] > img:nth-of-type(2) {
24 | display: initial;
25 | }
26 |
27 | /* Overlay the placeholder */
28 | picture[data-has-js][data-is-lazy] {
29 | position: relative;
30 | }
31 |
32 | picture[data-has-js][data-is-lazy] > img:nth-of-type(2) {
33 | position: absolute;
34 | left: 0;
35 | filter: blur(7px);
36 | opacity: 1;
37 | transition: opacity 3s;
38 | }
39 |
40 | /* Loading transitions */
41 |
42 | picture[data-has-js][data-is-lazy] img:nth-of-type(1) {
43 | opacity: 0;
44 | transition: opacity 1s;
45 | }
46 |
47 | picture[data-has-js][data-is-lazy] img:nth-of-type(1)[data-is-loaded] {
48 | opacity: 1;
49 | }
50 |
51 | picture[data-has-js][data-is-lazy] img:nth-of-type(1)[data-is-loaded] ~ img {
52 | opacity: 0;
53 | }
54 |
--------------------------------------------------------------------------------
/packages/imagekit/LICENSE:
--------------------------------------------------------------------------------
1 | ISC License
2 |
3 | Copyright (c) 2022 Julian Cataldo — https://www.juliancataldo.com
4 |
5 | Permission to use, copy, modify, and/or distribute this software for any
6 | purpose with or without fee is hereby granted, provided that the above
7 | copyright notice and this permission notice appear in all copies.
8 |
9 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10 | REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 | AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12 | INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 | LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
14 | OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 | PERFORMANCE OF THIS SOFTWARE.
16 |
--------------------------------------------------------------------------------
/packages/imagekit/base64.ts:
--------------------------------------------------------------------------------
1 | export async function getBase64DataURI(urlForB64: string) {
2 | const buffer = await fetch(urlForB64).then((r) => r.arrayBuffer());
3 |
4 | const b = Buffer.from(buffer).toString('base64');
5 |
6 | const b64Placeholder = `data:image/jpeg;base64,${b}`;
7 | return b64Placeholder;
8 | }
9 |
--------------------------------------------------------------------------------
/packages/imagekit/cli.ts:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env node
2 |
3 | import { program } from '@commander-js/extra-typings';
4 | import dotenv from 'dotenv';
5 | import { log } from './logger.js';
6 | import { pushToRemote } from './file-handlers.js';
7 | import { pullMediaIndex } from './sync-media-index.js';
8 | /* ========================================================================== */
9 |
10 | log(() => `Astro ImageKit — Command Line Interface`);
11 |
12 | /* TODO: Make it configurable */
13 | function loadEnv(envFile = './.env') {
14 | dotenv.config({ path: envFile });
15 | }
16 |
17 | /* —————————————————————————————————————————————————————————————————————————— */
18 |
19 | program
20 | .name('imagekit')
21 | .command('index')
22 | .description('Manage library index.')
23 | .option(
24 | '-e, --env-file ',
25 | 'Choose which env. file to use. Useful if sourcing from parent (mono-repo.).',
26 | )
27 | .option('-r, --pull', 'Pull remote index to local cache folder.')
28 | .option('-v, --verbose', 'Dump all outputs.')
29 |
30 | .action((options, _command) => {
31 | loadEnv(options.envFile);
32 |
33 | if (options.pull) {
34 | /* NOTE: This is a bit cumbersome */
35 | (async () =>
36 | pullMediaIndex({ verbose: options.verbose }).catch((e) => {
37 | throw e;
38 | }))().catch((e) => {
39 | throw e;
40 | });
41 | }
42 | });
43 |
44 | program
45 | .command('medias')
46 | .description('Manage library medias.')
47 | .option(
48 | '-s, --push',
49 | 'Push local files to ImageKit configured distributable directory.',
50 | )
51 | .option(
52 | '-e, --env-file ',
53 | 'Choose which env. file to use.\nUseful if sourcing from parent (mono-repo.).',
54 | )
55 | .action((options, _command) => {
56 | loadEnv(options.envFile);
57 |
58 | if (options.push) {
59 | (async () =>
60 | pushToRemote().catch((e) => {
61 | throw e;
62 | }))().catch((e) => {
63 | throw e;
64 | });
65 | }
66 | });
67 |
68 | program.parse();
69 |
--------------------------------------------------------------------------------
/packages/imagekit/env.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 |
3 | interface ImportMetaEnv {
4 | readonly IMAGEKIT_URL_ENDPOINT?: string | undefined;
5 | readonly IMAGEKIT_PUBLIC_KEY?: string | undefined;
6 | readonly IMAGEKIT_PRIVATE_KEY?: string | undefined;
7 | readonly IMAGEKIT_BASE_LOCAL_DIR?: string | undefined;
8 | readonly IMAGEKIT_REMOTE_DIR?: string | undefined;
9 | }
10 |
11 | interface ImportMeta {
12 | readonly env: ImportMetaEnv;
13 | }
14 |
--------------------------------------------------------------------------------
/packages/imagekit/index.ts:
--------------------------------------------------------------------------------
1 | import { integration } from './integration.js';
2 | import { pushToRemote } from './file-handlers.js';
3 |
4 | // NOTE: This is clashing with integration, must use
5 | // `import Image from 'astro-imagekit/Image.astro';` or setup pjson `exports`?
6 | // import Image from './Image.astro';
7 |
8 | export { /* Image, */ pushToRemote };
9 | export default integration;
10 |
--------------------------------------------------------------------------------
/packages/imagekit/logger.ts:
--------------------------------------------------------------------------------
1 | import yaml from 'yaml';
2 | import kleur from 'kleur';
3 | import { highlight } from 'cli-highlight';
4 |
5 | const logPrefix = () =>
6 | `${kleur.gray().dim(new Date().toLocaleTimeString())} ${kleur
7 | .magenta()
8 | .bold('[imagekit] ')}`;
9 |
10 | export function log(
11 | fmt: ({
12 | k,
13 | }: {
14 | /** Kleur formatting */
15 | k: typeof kleur;
16 | }) => string | undefined,
17 | ) {
18 | // if (import.meta.env.PROD) return;
19 |
20 | const formatted = fmt({ k: kleur });
21 | console.log(`${logPrefix()}${formatted ?? 'Undefined'}`);
22 | }
23 |
24 | export function dump(input: unknown) {
25 | // if (import.meta.env.PROD) return;
26 |
27 | const formatted = highlight(yaml.stringify(input, null, 2), {
28 | language: 'yaml',
29 | ignoreIllegals: true,
30 | });
31 |
32 | console.log(`${logPrefix()}— DUMP —\n${formatted}`);
33 | }
34 |
--------------------------------------------------------------------------------
/packages/imagekit/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@astro-content/imagekit",
3 | "version": "0.0.1-c",
4 | "description": "Integrate the ImageKit media provider in your Astro projects. Auto-synchronization, CLI, Component.",
5 | "keywords": [
6 | "medias",
7 | "astro-integration",
8 | "experimental",
9 | "astro-component",
10 | "astro",
11 | "image",
12 | "ssr",
13 | "transformation",
14 | "cloud",
15 | "imagekit",
16 | "responsive",
17 | "transitions",
18 | "synchronization",
19 | "cloudinary",
20 | "component",
21 | "indexing",
22 | "api",
23 | "cli",
24 | "urls",
25 | "helpers"
26 | ],
27 | "license": "ISC",
28 | "author": "Julian Cataldo",
29 | "type": "module",
30 | "main": "./dist/index.js",
31 | "bin": {
32 | "imagekit": "./dist/cli.js"
33 | },
34 | "files": [
35 | "./dist/*",
36 | "./Image.css",
37 | "./Image.astro"
38 | ],
39 | "scripts": {
40 | "build": "tsc",
41 | "clean": "rm -rf dist .turbo",
42 | "dev": "tsc -w",
43 | "test": "echo \"Error: no test specified\" && exit 0"
44 | },
45 | "dependencies": {
46 | "@commander-js/extra-typings": "^9.4.1",
47 | "cli-highlight": "^2.1.11",
48 | "commander": "^9.4.1",
49 | "dotenv": "^16.0.3",
50 | "glob-promise": "^5.0.0",
51 | "imagekit": "^4.1.2",
52 | "kleur": "^4.1.5",
53 | "yaml": "^2.2.1"
54 | },
55 | "devDependencies": {
56 | "@types/node": "^18.11.18",
57 | "astro": "^1.9.2"
58 | },
59 | "publishConfig": {
60 | "access": "public"
61 | },
62 | "typedoc": {
63 | "entryPoint": "./index.ts",
64 | "readmeFile": "README.md",
65 | "displayName": "imagekit"
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/packages/imagekit/sync-media-index.ts:
--------------------------------------------------------------------------------
1 | import fs from 'node:fs/promises';
2 | import path from 'node:path';
3 | import {
4 | getImageKitInstance,
5 | cacheDir,
6 | cacheIndex,
7 | } from './imagekit-instance.js';
8 | import { dump } from './logger.js';
9 | /* ========================================================================== */
10 |
11 | export async function pullMediaIndex({ verbose = false }) {
12 | const mediaIndexPath = path.join(cacheDir, cacheIndex);
13 |
14 | const { imageKit } = getImageKitInstance();
15 |
16 | /* TODO: Should filter base local dir */
17 | const remoteIndex = await imageKit.listFiles({});
18 |
19 | if (verbose) dump(remoteIndex);
20 |
21 | await fs.mkdir(path.dirname(mediaIndexPath), { recursive: true });
22 |
23 | await fs.writeFile(mediaIndexPath, JSON.stringify(remoteIndex, null, 2));
24 | }
25 |
--------------------------------------------------------------------------------
/packages/imagekit/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | // Enable top-level await, and other modern ESM features.
4 | "target": "ESNext",
5 | "module": "ESNext",
6 | // Enable node-style module resolution, for things like npm package imports.
7 | "moduleResolution": "node",
8 | // Enable JSON imports.
9 | "resolveJsonModule": true,
10 | // Enable stricter transpilation for better output.
11 | "isolatedModules": true,
12 | // Add type definitions for our Astro runtime.
13 | "types": [
14 | //
15 | "astro/client",
16 | // "vite/client",
17 | "node"
18 | ],
19 |
20 | "baseUrl": ".",
21 |
22 | "allowSyntheticDefaultImports": true,
23 |
24 | "noImplicitAny": true,
25 |
26 | "strictNullChecks": true,
27 |
28 | "importsNotUsedAsValues": "error",
29 |
30 | // "noEmitOnError": false,
31 | "outDir": "./dist",
32 |
33 | "declaration": true
34 | },
35 |
36 | "include": ["index.ts", "cli.ts"]
37 | }
38 |
--------------------------------------------------------------------------------
/packages/integration/build.ts:
--------------------------------------------------------------------------------
1 | import type { AstroIntegration } from 'astro';
2 | import fs from 'node:fs/promises';
3 | import path from 'node:path';
4 | /* ·········································································· */
5 | import { endpoints } from '@astro-content/server/state';
6 | import { log } from '@astro-content/server/logger';
7 | import type { ServerState, Endpoint } from '@astro-content/types/server-state';
8 | /* —————————————————————————————————————————————————————————————————————————— */
9 |
10 | // TODO: Centralize `tempDir`
11 | const tempDir = path.join(process.cwd(), '.astro-content');
12 |
13 | const buildStart: AstroIntegration['hooks']['astro:build:start'] =
14 | async () => {};
15 |
16 | const buildDone: AstroIntegration['hooks']['astro:build:done'] = async () => {
17 | log(`Build done`);
18 |
19 | if (process.env.HAS_GUI === 'true') {
20 | // REFACTOR: Even if it's not supposed to be used by end user (yet?)
21 |
22 | // NOTE: We are saving / loading current state to files,
23 | // otherwise it will get erased.
24 | // IDEA: Test the new `astro:build:generated` hook maybe?
25 | await fs
26 | .readFile(path.join(tempDir, 'state.json'), 'utf-8')
27 | .then(async (data: unknown) => {
28 | if (typeof data === 'string') {
29 | const obj = JSON.parse(data) as ServerState;
30 |
31 | if (typeof obj === 'object') {
32 | return Promise.all(
33 | Object.entries(obj).map(async ([key]) => {
34 | const dest = path.join(
35 | process.cwd(),
36 | `dist${endpoints.apiBase}/${key}`,
37 | );
38 |
39 | return fs
40 | .writeFile(dest, JSON.stringify(obj[key as Endpoint]))
41 | .catch((e) => log(e));
42 | }),
43 | );
44 | }
45 | }
46 | return null;
47 | });
48 | }
49 | };
50 |
51 | export { buildStart, buildDone };
52 |
--------------------------------------------------------------------------------
/packages/integration/cli-bridge.ts:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env node --no-warnings --experimental-specifier-resolution=node --experimental-json-modules
2 |
3 | import '@astro-content/cli';
4 |
--------------------------------------------------------------------------------
/packages/integration/load-jsonc-plugin.ts:
--------------------------------------------------------------------------------
1 | // Based on: https://github.com/Modyfi/vite-plugin-yaml
2 | // NOTE: Work in progress
3 | // IDEA: Could make this an independent package / plugin?
4 |
5 | import type { Plugin } from 'vite';
6 |
7 | /* —————————————————————————————————————————————————————————————————————————— */
8 |
9 | const jsoncExtension = /\.json?c$/;
10 |
11 | /**
12 | * Transform YAML files to JS objects.
13 | */
14 | export default (): Plugin => ({
15 | name: 'vite:transform-jsonc',
16 |
17 | // transform(code: string, id: string) {
18 | // if (jsoncExtension.test(id)) {
19 | // const JsoncInstance = `${code.replace('export ', '')}`;
20 |
21 | // return {
22 | // code: JsoncInstance,
23 | // };
24 | // }
25 | // return null;
26 | // },
27 | });
28 |
--------------------------------------------------------------------------------
/packages/integration/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "astro-content",
3 | "version": "0.0.0-alpha.9",
4 | "description": "",
5 | "// source": "./astro-integration.ts",
6 | "main": "./dist/astro-integration.js",
7 | "type": "module",
8 | "files": [
9 | "dist/*",
10 | "*.astro",
11 | "*.json.ts"
12 | ],
13 | "scripts": {
14 | "build": "tsc",
15 | "dev": "tsc -w",
16 | "clean": "rm -rf dist .turbo",
17 | "test": "echo \"Error: no test specified\" && exit 1"
18 | },
19 | "bin": {
20 | "content": "./dist/cli-bridge.js"
21 | },
22 | "devDependencies": {
23 | "@types/body-parser": "^1.19.2",
24 | "@types/js-yaml": "^4.0.5",
25 | "astro": "1.4.7",
26 | "vite-plugin-inspect": "^0.7.5"
27 | },
28 | "dependencies": {
29 | "@astro-content/cli": "workspace:*",
30 | "@astro-content/gui": "workspace:*",
31 | "@astro-content/server": "workspace:*",
32 | "@astro-content/types": "workspace:*",
33 | "@astrojs/mdx": "^0.11.4",
34 | "@astrojs/react": "^1.2.0",
35 | "@rollup/pluginutils": "^5.0.0",
36 | "body-parser": "^1.20.1",
37 | "import-meta-resolve": "^2.1.0",
38 | "js-yaml": "^4.1.0",
39 | "kleur": "^4.1.5",
40 | "mkdirp": "^1.0.4",
41 | "remark-embed": "^1.3.1",
42 | "remark-gfm": "^3.0.1",
43 | "tosource": "2.0.0-alpha.3",
44 | "yaml": "^2.1.3"
45 | },
46 | "keywords": [
47 | "astro",
48 | "astro-integration"
49 | ],
50 | "author": "Julian Cataldo",
51 | "license": "ISC",
52 | "publishConfig": {
53 | "access": "public"
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/packages/integration/server-bridge.json.ts:
--------------------------------------------------------------------------------
1 | import type { APIRoute } from 'astro';
2 | /* ·········································································· */
3 | import type { Endpoint } from '@astro-content/types/server-state';
4 | import { state, endpoints } from '@astro-content/server/state';
5 | import { log } from '@astro-content/server/logger';
6 | /* —————————————————————————————————————————————————————————————————————————— */
7 |
8 | export function getStaticPaths() {
9 | return endpoints.data.map((endpoint) => ({ params: { endpoint } }));
10 | }
11 |
12 | export const get: APIRoute = ({ params, request }) => {
13 | // NOTE: Only "GET" seems to work?
14 | log({ params, method: request.method }, 'absurd');
15 |
16 | const endpoint = params.endpoint as Endpoint;
17 |
18 | if (
19 | request.method === 'GET' &&
20 | typeof params.endpoint === 'string' &&
21 | endpoints.data.includes(endpoint)
22 | ) {
23 | log({ params, method: request.method });
24 | return {
25 | body: JSON.stringify(state[endpoint]),
26 | };
27 | }
28 |
29 | /* No endpoint found, send empty response body */
30 | return {
31 | body: '{}',
32 | };
33 | };
34 |
--------------------------------------------------------------------------------
/packages/integration/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | // Enable top-level await, and other modern ESM features.
4 | "target": "ESNext",
5 | "module": "ESNext",
6 | // Enable node-style module resolution, for things like npm package imports.
7 | "moduleResolution": "node",
8 | // Enable JSON imports.
9 | "resolveJsonModule": true,
10 | // Enable stricter transpilation for better output.
11 | "isolatedModules": true,
12 | // Add type definitions for our Astro runtime.
13 | "types": [
14 | //
15 | "astro/client",
16 | "node"
17 | ],
18 |
19 | "baseUrl": ".",
20 |
21 | // Mandatory MDX integration, for tsc to build
22 | "jsx": "react-jsx",
23 |
24 | "allowSyntheticDefaultImports": true,
25 |
26 | "noImplicitAny": true,
27 |
28 | "strictNullChecks": true,
29 |
30 | "importsNotUsedAsValues": "error",
31 |
32 | // "noEmitOnError": false,
33 | "outDir": "./dist",
34 |
35 | "declaration": true
36 | }
37 |
38 | // "include": ["./packages/integration/astro-integration.ts"]
39 | // "exclude": ["./**/node_modules/*"]
40 | }
41 |
--------------------------------------------------------------------------------
/packages/server/.npmignore:
--------------------------------------------------------------------------------
1 | .dev
2 |
--------------------------------------------------------------------------------
/packages/server/config.ts:
--------------------------------------------------------------------------------
1 | /* ·········································································· */
2 | import type { UserConfig } from '@astro-content/types/user-config';
3 | /* —————————————————————————————————————————————————————————————————————————— */
4 |
5 | // let userConfig: Partial;
6 |
7 | const conf: UserConfig = {
8 | // get previewUrl() {
9 | // return userConfig?.previewUrl || '/';
10 | // },
11 | };
12 |
13 | export { conf };
14 |
--------------------------------------------------------------------------------
/packages/server/core-schema-validation.ts:
--------------------------------------------------------------------------------
1 | // /* Core meta schema validation */
2 | // let validate;
3 | // console.log({ coreSchema });
4 | // try {
5 | // const schemaForAjv = {
6 | // definitions: { ...state.schemas.internals, object: file.data },
7 | // };
8 |
9 | // validate = ajv.compile(schemaForAjv);
10 | // } catch (_) {
11 | // return false;
12 | // }
13 | // if (validate) {
14 | // validate(file.data);
15 | // if (validate.errors) {
16 | // }
17 | // }
18 | export default function coreSchemaValidation() {}
19 |
--------------------------------------------------------------------------------
/packages/server/generate-fake-data.ts:
--------------------------------------------------------------------------------
1 | import jsf from 'json-schema-faker';
2 | import type { JSONSchema7 } from 'json-schema';
3 | /* ·········································································· */
4 | import { log } from './logger.js';
5 | /* —————————————————————————————————————————————————————————————————————————— */
6 |
7 | export async function generateFakeEntries(schema: JSONSchema7) {
8 | // NOTE: This is a fix for `process.browser` bug, `location.href` not found.
9 | globalThis.location = { ...globalThis.location, href: process.cwd() };
10 |
11 | const fakeEntries = await jsf.resolve(schema).catch((e) => {
12 | log(e, 'absurd');
13 | return {};
14 | });
15 |
16 | log({ schema, fakeEntries }, 'absurd');
17 |
18 | return fakeEntries;
19 | }
20 |
--------------------------------------------------------------------------------
/packages/server/index.ts:
--------------------------------------------------------------------------------
1 | // IDEA: Use this for root importing functions?
2 | // Might be useful for distributable
3 |
4 | // export { collect } from './collect.js';
5 |
6 | export {};
7 |
--------------------------------------------------------------------------------
/packages/server/logger.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable no-console */
2 | import { blue, bold, dim } from 'kleur/colors';
3 | // TODO: Try consola
4 | // import consola from 'consola';
5 | /* ·········································································· */
6 | import type { LogLevel } from '@astro-content/types/logger';
7 | /* —————————————————————————————————————————————————————————————————————————— */
8 |
9 | export enum Levels {
10 | silent,
11 | info,
12 | debug,
13 | absurd,
14 | }
15 |
16 | export type Mode = 'pretty' | 'dump' | 'table';
17 |
18 | let currentLevel: LogLevel = 'info';
19 | const defaultLevel: LogLevel = 'debug';
20 |
21 | export function getCurrentLevel() {
22 | return currentLevel;
23 | }
24 |
25 | export function setLogLevel(level: LogLevel) {
26 | // if (process.argv.includes('--verbose')) {
27 | // currentLevel = 'debug';
28 | // } else if (process.argv.includes('--silent')) {
29 | // currentLevel = 'silent';
30 | // } else if (process.argv.includes('--absurd')) {
31 | // currentLevel = 'absurd';
32 | // }
33 | currentLevel = level;
34 | }
35 |
36 | export function log(
37 | //
38 | value: unknown,
39 | level?: LogLevel,
40 | mode: Mode = 'dump',
41 | // TODO: Try consola
42 | // type: 'success' | 'info' | 'error' = 'info',
43 | ) {
44 | let loggingLevel: LogLevel;
45 | if (!level) {
46 | loggingLevel = defaultLevel;
47 | } else {
48 | loggingLevel = level;
49 | }
50 |
51 | if (Levels[loggingLevel] <= Levels[currentLevel]) {
52 | if (mode === 'pretty') {
53 | const literal = typeof value === 'string' ? value : JSON.stringify(value);
54 | const time = new Date().toLocaleTimeString();
55 |
56 | console.log(
57 | `${dim(time)} ` +
58 | // —————————————————————————————————————————————————
59 | `${bold(blue('[content]'))} ${literal}`,
60 | );
61 | } else if (mode === 'table') {
62 | console.table(value);
63 | } else {
64 | /* Default : dump as is */
65 | console.log(value);
66 | }
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/packages/server/save-file.ts:
--------------------------------------------------------------------------------
1 | import fs from 'node:fs/promises';
2 | import prettier from 'prettier';
3 | /* ·········································································· */
4 | import type { Save } from '@astro-content/types/dto';
5 | import { log } from './logger.js';
6 | /* —————————————————————————————————————————————————————————————————————————— */
7 |
8 | export async function saveFile(object: Save) {
9 | const { file: dest, value, language } = object;
10 |
11 | let formattedValue: string | false = false;
12 | if (language) {
13 | formattedValue = prettier.format(value, {
14 | parser: language,
15 | // NOTE: Double quotes in MDX imports are breaking highlighting
16 | singleQuote: true,
17 | });
18 | log({ formattedValue, language }, 'debug');
19 | }
20 |
21 | const isSuccess = await fs
22 | .writeFile(dest, formattedValue || value)
23 | .then(() => true)
24 | .catch((e) => {
25 | log(e, 'info');
26 | return false;
27 | });
28 | return isSuccess;
29 | }
30 |
--------------------------------------------------------------------------------
/packages/server/schemas/MarkdownFile.ts:
--------------------------------------------------------------------------------
1 | import type { JSONSchema7 } from 'json-schema';
2 |
3 | export default {
4 | title: 'Markdown file',
5 | description: 'Markdown content of this entry with frontmatter',
6 | properties: {
7 | file: { type: 'string' },
8 | headingsCompiled: {
9 | type: 'array',
10 | items: [
11 | {
12 | properties: {
13 | depth: { type: 'number' },
14 | slug: { type: 'string' },
15 | text: { type: 'string' },
16 | },
17 | required: ['depth', 'slug', 'text'],
18 | additionalProperties: false,
19 | },
20 | ],
21 | },
22 | // headings: {
23 | // type: 'null',
24 | // },
25 | Content: { type: 'string' },
26 | },
27 | required: ['headings', 'Content'],
28 | additionalProperties: false,
29 | } as JSONSchema7;
30 |
--------------------------------------------------------------------------------
/packages/server/schemas/default.schema.yaml:
--------------------------------------------------------------------------------
1 | properties:
2 | gallery:
3 | properties:
4 | source:
5 | type: string
6 | required:
7 | - source
8 |
9 | meta:
10 | properties:
11 | baz:
12 | type: string
13 | foo:
14 | type: string
15 | enum:
16 | - bar
17 | - moz
18 | - das
19 | required:
20 | - foo
21 |
22 | content:
23 | allOf:
24 | - $ref: '#/definitions/MarkdownFile'
25 | - properties:
26 | frontmatter:
27 | properties:
28 | title:
29 | description: Entry title
30 | type: string
31 | image:
32 | description: Image path
33 | type: string
34 | required:
35 | - title
36 | required:
37 | - frontmatter
38 |
39 | footnotes:
40 | allOf:
41 | - $ref: '#/definitions/MarkdownFile'
42 |
43 | required:
44 | - content
45 | - meta
46 | - gallery
47 | - footnotes
48 |
--------------------------------------------------------------------------------
/packages/server/state.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable max-lines */
2 | // import path from 'node:path';
3 | import type { JSONSchema7 } from 'json-schema';
4 | /* ·········································································· */
5 | import type { Endpoint, ServerState } from '@astro-content/types/server-state';
6 | import markdownFile from './schemas/MarkdownFile.js';
7 | /* —————————————————————————————————————————————————————————————————————————— */
8 |
9 | // TODO: Take this from user config / Vite
10 | // const contentDir = path.join(process.cwd(), 'content');
11 |
12 | const emptyState: ServerState = {
13 | content: {},
14 |
15 | schemas: {
16 | content: {},
17 | raw: {},
18 | internals: {
19 | MarkdownFile: markdownFile as JSONSchema7,
20 | },
21 | file: {},
22 | },
23 |
24 | reports: {},
25 |
26 | types: {
27 | common: '',
28 | ide: '',
29 | browser: '',
30 | },
31 |
32 | config: {
33 | previewUrl: '/',
34 | // TODO: auto-detection + injection for GUI command hints for example
35 | // packageManager: 'pnpm',
36 | },
37 | };
38 |
39 | const getEmptyState = () =>
40 | JSON.parse(JSON.stringify(emptyState)) as ServerState;
41 |
42 | const state = getEmptyState();
43 |
44 | const data: Endpoint[] = [
45 | 'schemas',
46 | 'types',
47 | 'config',
48 | 'content',
49 | 'reports',
50 | //
51 | ];
52 |
53 | const contentBase = '/__content';
54 | const apiBase = `${contentBase}/api`;
55 | const endpoints = {
56 | data,
57 | contentBase,
58 | apiBase,
59 | actions: {
60 | save: `${apiBase}/~save`,
61 | fake: `${apiBase}/~fake`,
62 | validate: `${apiBase}/~validate`,
63 | refresh: `${apiBase}/~refresh`,
64 | render: `${apiBase}/~render`,
65 | },
66 | };
67 |
68 | export {
69 | //
70 | state,
71 | endpoints,
72 | getEmptyState,
73 | // contentDir,
74 | };
75 |
--------------------------------------------------------------------------------
/packages/server/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | // Enable top-level await, and other modern ESM features.
4 | "target": "ESNext",
5 | "module": "ESNext",
6 | // Enable node-style module resolution, for things like npm package imports.
7 | "moduleResolution": "node",
8 | // Enable JSON imports.
9 | "resolveJsonModule": true,
10 | // Enable stricter transpilation for better output.
11 | "isolatedModules": true,
12 | // Add type definitions for our Astro runtime.
13 | "types": [
14 | //
15 | "astro/client",
16 | "node"
17 | ],
18 |
19 | "baseUrl": ".",
20 |
21 | // "jsx": "react-jsxdev",
22 |
23 | "allowSyntheticDefaultImports": true,
24 |
25 | "noImplicitAny": true,
26 |
27 | "strictNullChecks": true,
28 |
29 | "importsNotUsedAsValues": "error",
30 |
31 | "declaration": true,
32 |
33 | "outDir": "./dist"
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/packages/server/utils.ts:
--------------------------------------------------------------------------------
1 | import path from 'node:path';
2 | import { camelCase } from 'lodash-es';
3 | /* ·········································································· */
4 |
5 | /* —————————————————————————————————————————————————————————————————————————— */
6 |
7 | export function getTrio(filePath: string) {
8 | // const relPath = path.relative(
9 | // 'content',
10 | // path.relative(process.cwd(), filePath),
11 | // );
12 |
13 | const parts = filePath.split('/');
14 | let [third, second, first] = [parts.pop(), parts.pop(), parts.pop()];
15 |
16 | first = camelCase(first);
17 | second = camelCase(second);
18 | if (third) {
19 | const t = path.basename(third, path.extname(third));
20 | if (!t.startsWith('_')) {
21 | third = camelCase(t);
22 | }
23 | }
24 | return { first, second, third };
25 | }
26 |
--------------------------------------------------------------------------------
/packages/types/dto.ts:
--------------------------------------------------------------------------------
1 | import type { JSONSchema7 } from 'json-schema';
2 | import type { Part } from './gui-state';
3 |
4 | export interface Save {
5 | file: string;
6 | singular: string;
7 | value: string;
8 | language: string | null;
9 | }
10 |
11 | export interface Fake {
12 | schema: JSONSchema7;
13 | }
14 |
15 | export interface Validate {
16 | entity: Part;
17 | entry: Part;
18 | property: Part;
19 | schema: JSONSchema7;
20 | value: string;
21 | language: string | null;
22 | }
23 |
24 | export interface Response {
25 | success: boolean;
26 | }
27 |
--------------------------------------------------------------------------------
/packages/types/file.ts:
--------------------------------------------------------------------------------
1 | // TODO: Rehaul file types: align Astro <=> JSONSchema <=> Astro Content
2 |
3 | import type { MarkdownHeading, MarkdownInstance, MDXInstance } from 'astro';
4 |
5 | export type FileLanguage = 'yaml' | 'markdown' | 'mdx';
6 |
7 | interface FileInfo {
8 | language: Lang;
9 | }
10 |
11 | export type OriginalInstance =
12 | | MarkdownInstance>
13 | | MDXInstance>
14 | | YamlInstance;
15 |
16 | export type FileInstance =
17 | | (MarkdownInstance> & FileInfo<'markdown'>)
18 | | (MDXInstance> & FileInfo<'mdx'>)
19 | | (YamlInstance & FileInfo<'yaml'>);
20 |
21 | export type FileInstanceExtended =
22 | | (MarkdownInstance> & ExtraMd)
23 | | (MDXInstance> & ExtraMdx)
24 | | (YamlInstance & ExtraYaml);
25 |
26 | interface MdBase {
27 | headingsCompiled?: MarkdownHeading[];
28 | excerpt?: { html: string };
29 | }
30 | export interface ExtraMd extends MdBase {
31 | language: 'markdown';
32 | raw: string;
33 | // bodyCompiled?: string;
34 | }
35 | export interface ExtraMdx extends MdBase {
36 | language: 'mdx';
37 | raw: string;
38 | }
39 | export interface ExtraYaml {
40 | language: 'yaml';
41 | }
42 |
43 | /* For Vite YAML loader plugin */
44 | export interface YamlInstance {
45 | data: T;
46 | /** Absolute file path (e.g. `/home/user/projects/.../file.yaml`) */
47 | file: string;
48 |
49 | raw: string;
50 | }
51 |
--------------------------------------------------------------------------------
/packages/types/integration.ts:
--------------------------------------------------------------------------------
1 | import type { UserConfig } from './user-config';
2 |
3 | export type Settings = UserConfig;
4 |
5 | export interface Options {
6 | editMode?: boolean;
7 | }
8 |
--------------------------------------------------------------------------------
/packages/types/logger.ts:
--------------------------------------------------------------------------------
1 | export type LogLevel = 'silent' | 'info' | 'debug' | 'absurd';
2 |
3 | export type Mode = 'pretty' | 'dump' | 'table';
4 |
--------------------------------------------------------------------------------
/packages/types/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@astro-content/types",
3 | "version": "0.0.0-alpha.13",
4 | "description": "",
5 | "type": "module",
6 | "files": [
7 | "dist/*.d.ts",
8 | "*.ts"
9 | ],
10 | "exports": {
11 | ".": "./dist",
12 | "./*": "./dist/*.js"
13 | },
14 | "scripts": {
15 | "build": "tsc",
16 | "dev": "tsc -w",
17 | "clean": "rm -rf dist .turbo",
18 | "test": "echo \"Error: no test specified\" && exit 1"
19 | },
20 | "keywords": [],
21 | "author": "Julian Cataldo",
22 | "license": "ISC",
23 | "publishConfig": {
24 | "access": "public"
25 | },
26 | "devDependencies": {
27 | "remark-lint-frontmatter-schema": "^3.10.0"
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/packages/types/server-state.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable @typescript-eslint/consistent-indexed-object-style */
2 | import type { JSONSchema7 } from 'json-schema';
3 | /* ·········································································· */
4 | import type { FileInstanceExtended } from './file';
5 | import type { PropertyReport } from './reports';
6 | /* —————————————————————————————————————————————————————————————————————————— */
7 |
8 | export interface Content {
9 | [entity: string]:
10 | | {
11 | [entry: string]:
12 | | {
13 | [property: string]: FileInstanceExtended | undefined;
14 | }
15 | | undefined;
16 | }
17 | | undefined;
18 | }
19 |
20 | export interface Schemas {
21 | internals: { [schemaName: string]: JSONSchema7 };
22 | content: { [schemaName: string]: JSONSchema7 };
23 | raw: { [schemaName: string]: string };
24 | file: { [schemaName: string]: string };
25 | }
26 |
27 | export interface Reports {
28 | [entity: string]:
29 | | {
30 | [entry: string]:
31 | | {
32 | [property: string]: PropertyReport | undefined;
33 | }
34 | | undefined;
35 | }
36 | | undefined;
37 | }
38 |
39 | export interface Types {
40 | common: string;
41 | browser: string;
42 | ide: string;
43 | }
44 |
45 | export interface ServerState {
46 | content: Content;
47 |
48 | schemas: Schemas;
49 |
50 | reports: Reports;
51 |
52 | types: Types;
53 |
54 | config: {
55 | previewUrl?: string;
56 | };
57 | }
58 | export type Endpoint = keyof ServerState;
59 |
60 | // NOTE: Unused for now
61 | // export type Action = 'save' | 'validate';
62 |
--------------------------------------------------------------------------------
/packages/types/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | // Enable top-level await, and other modern ESM features.
4 | "target": "ESNext",
5 | "module": "ESNext",
6 | // Enable node-style module resolution, for things like npm package imports.
7 | "moduleResolution": "node",
8 | // Enable JSON imports.
9 | "resolveJsonModule": true,
10 | // Enable stricter transpilation for better output.
11 | "isolatedModules": true,
12 | // Add type definitions for our Astro runtime.
13 | "types": [
14 | //
15 | "astro/client",
16 | "node"
17 | ],
18 |
19 | "baseUrl": ".",
20 |
21 | // "jsx": "react-jsxdev",
22 |
23 | "allowSyntheticDefaultImports": true,
24 |
25 | "noImplicitAny": true,
26 |
27 | "strictNullChecks": true,
28 |
29 | "importsNotUsedAsValues": "error",
30 |
31 | // "noEmitOnError": false,
32 | "outDir": "./dist",
33 |
34 | "emitDeclarationOnly": true,
35 | "declaration": true
36 | }
37 |
38 | // "include": ["./packages/integration/astro-integration.ts"]
39 | // "exclude": ["./**/node_modules/*"]
40 | }
41 |
--------------------------------------------------------------------------------
/packages/types/user-config.ts:
--------------------------------------------------------------------------------
1 | import type { LogLevel } from './logger';
2 |
3 | export interface UserConfig {
4 | /** **Default**: `/` */
5 | previewUrl?: string;
6 |
7 | /** **Default**: `'info'` */
8 | logLevel?: LogLevel;
9 |
10 | // /** **Default**: `true` */
11 | gui?: boolean;
12 |
13 | /** **Default**: `false` */
14 | includeInBuild?: boolean;
15 | }
16 |
--------------------------------------------------------------------------------
/packages/validator/cli.ts:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env node
2 |
3 | /* eslint-disable no-console */
4 |
5 | import { generateAllCheckers } from './schema-to-validator.js';
6 |
7 | console.log('Generating checkers…');
8 |
9 | const outDir = process.argv[2];
10 |
11 | console.log(`➤ Output directory: ${outDir ?? 'colocated'}`);
12 |
13 | await generateAllCheckers(outDir);
14 |
15 | export {};
16 |
--------------------------------------------------------------------------------
/packages/validator/demo/.gitignore:
--------------------------------------------------------------------------------
1 | # build output
2 | dist/
3 | .output/
4 |
5 | # dependencies
6 | node_modules/
7 |
8 | # logs
9 | npm-debug.log*
10 | yarn-debug.log*
11 | yarn-error.log*
12 | pnpm-debug.log*
13 |
14 |
15 | # environment variables
16 | .env
17 | .env.production
18 |
19 | # macOS-specific files
20 | .DS_Store
21 |
--------------------------------------------------------------------------------
/packages/validator/demo/.remarkrc.yaml:
--------------------------------------------------------------------------------
1 | plugins:
2 | - remark-frontmatter
3 |
4 | - - remark-lint-frontmatter-schema
5 | - schemas:
6 | src/schemas/blog-post.schema.yaml:
7 | - content/blog-posts/*.{md,mdx}
8 |
--------------------------------------------------------------------------------
/packages/validator/demo/README.md:
--------------------------------------------------------------------------------
1 | # 🧞 Commands
2 |
3 | All commands are run from the root of the project, from a terminal:
4 |
5 | | Command | Action |
6 | | :--------------------- | :------------------------------------------------- |
7 | | `npm install` | Installs dependencies |
8 | | `npm run dev` | Starts local dev server at `localhost:3000` |
9 | | `npm run build` | Build your production site to `./dist/` |
10 | | `npm run preview` | Preview your build locally, before deploying |
11 | | `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` |
12 | | `npm run astro --help` | Get help using the Astro CLI |
13 |
--------------------------------------------------------------------------------
/packages/validator/demo/astro.config.mjs:
--------------------------------------------------------------------------------
1 | import { defineConfig } from 'astro/config';
2 | import contentValidator from '@astro-content/validator';
3 |
4 | // https://astro.build/config
5 | export default defineConfig({
6 | integrations: [
7 | //
8 | contentValidator({ outDir: 'src/checkers' }),
9 | ],
10 | });
11 |
--------------------------------------------------------------------------------
/packages/validator/demo/content/blog-posts/correct_entry-bar.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: This is a cool title.
3 |
4 | description: |
5 | My description is long enough to make the schema happy.
6 | More text. More text. More text. More text. More text.
7 | ---
8 |
9 | # Hello
10 |
11 | World.
12 |
13 | Lorem ipsum dolor sit amet consectetur adipisicing elit. Deleniti delectus enim natus ex optio beatae atque iusto? Reprehenderit animi et ullam veniam quia, doloribus, omnis eius consequuntur suscipit nobis veritatis?
14 |
15 | ## Hey
16 |
17 | Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquam totam blanditiis culpa nulla non itaque est dolorum ullam minima, animi vero quidem ea perspiciatis nisi alias dolore laboriosam deserunt placeat!
18 |
--------------------------------------------------------------------------------
/packages/validator/demo/content/blog-posts/wrong_entry-foo.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: 123456 # Should be string!
3 |
4 | # description: oh no. # This is missing!
5 |
6 | tags:
7 | - 123456
8 | ---
9 |
10 | # Salut
11 |
12 | World.
13 |
14 | Lorem ipsum dolor sit amet consectetur adipisicing elit. Et inventore ea in, saepe, veritatis deserunt cum est voluptatem illo sapiente quis omnis fugiat nobis molestias autem eius magni sunt odio.
15 |
16 | ## Ola
17 |
18 | Lorem ipsum, dolor sit amet consectetur adipisicing elit. Commodi voluptatum ad ut magni repellat optio totam atque delectus libero? Architecto ipsum dignissimos earum molestias mollitia vel voluptatem ab quia enim!
19 |
20 | Lorem, ipsum dolor sit amet consectetur adipisicing elit. Aperiam esse et doloremque laborum minus voluptatibus officia maiores? Dicta, unde. Ipsam reiciendis consectetur porro quo in accusamus dolorem placeat, voluptatum asperiores.
21 |
--------------------------------------------------------------------------------
/packages/validator/demo/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@example/basics",
3 | "type": "module",
4 | "version": "0.0.1",
5 | "private": true,
6 | "scripts": {
7 | "dev": "astro dev",
8 | "start": "astro dev",
9 | "build": "astro build",
10 | "preview": "astro preview",
11 | "astro": "astro"
12 | },
13 | "dependencies": {
14 | "@astro-content/validator": "latest",
15 | "astro": "^1.6.10"
16 | },
17 | "devDependencies": {
18 | "remark": "^14.0.2",
19 | "remark-cli": "^11.0.0"
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/packages/validator/demo/pnpm-workspace.yaml:
--------------------------------------------------------------------------------
1 | # STUB (ignore it).
2 |
--------------------------------------------------------------------------------
/packages/validator/demo/src/components/Card.astro:
--------------------------------------------------------------------------------
1 | ---
2 | export interface Props {
3 | title: string;
4 | body: string;
5 | href: string;
6 | }
7 |
8 | const { href, title, body } = Astro.props;
9 | ---
10 |
11 |
12 |
13 |
14 | {title}
15 | →
16 |
17 |
18 | {body}
19 |
20 |
21 |
22 |
63 |
--------------------------------------------------------------------------------
/packages/validator/demo/src/env.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 |
--------------------------------------------------------------------------------
/packages/validator/demo/src/layouts/Layout.astro:
--------------------------------------------------------------------------------
1 | ---
2 | export interface Props {
3 | title: string;
4 | }
5 |
6 | const { title } = Astro.props;
7 | ---
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | {title}
17 |
18 |
19 |
20 |
21 |
22 |
36 |
--------------------------------------------------------------------------------
/packages/validator/demo/src/schemas/blog-post.schema.yaml:
--------------------------------------------------------------------------------
1 | title: Blog post
2 |
3 | allOf:
4 | - $ref: ./tags.schema.yaml
5 |
6 | - properties:
7 | title:
8 | title: Title
9 | default: My untitled blog post
10 | description: Used for SEO and tab title! # Will appear in auto-completion
11 | type: string
12 | minLength: 1
13 | maxLength: 80
14 |
15 | description:
16 | title: Description
17 | default: No description found.
18 | description: Used for SEO
19 | type: string
20 | minLength: 100
21 | maxLength: 300
22 |
23 | required:
24 | - title
25 | - description
26 |
--------------------------------------------------------------------------------
/packages/validator/demo/src/schemas/tags.schema.yaml:
--------------------------------------------------------------------------------
1 | description: |
2 | Used for content classification
3 |
4 | properties:
5 | tags:
6 | type: array
7 | uniqueItems: true
8 | minItems: 1
9 | maxItems: 8
10 | items:
11 | type: string
12 | enum:
13 | - Music
14 | - Video
15 | - Development
16 | - Cooking
17 | - Gardening
18 | - Sport
19 |
--------------------------------------------------------------------------------
/packages/validator/demo/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "astro/tsconfigs/strictest",
3 | "base": "."
4 | }
5 |
--------------------------------------------------------------------------------
/packages/validator/index.ts:
--------------------------------------------------------------------------------
1 | import { generateChecker, generateAllCheckers } from './schema-to-validator.js';
2 | import { integration, type Settings } from './integration.js';
3 | import { itemChecker } from './validator.js';
4 |
5 | export {
6 | Settings,
7 | /* ———————————————————————————————————————————————————————————————————————— */
8 | itemChecker,
9 | generateChecker,
10 | generateAllCheckers,
11 | };
12 |
13 | export default integration;
14 |
--------------------------------------------------------------------------------
/packages/validator/integration.ts:
--------------------------------------------------------------------------------
1 | import type { AstroIntegration } from 'astro';
2 | /* ========================================================================== */
3 |
4 | export interface Settings {
5 | /**
6 | * Destination directory for the generated checkers.
7 | *
8 | * E.g. `src/checkers`
9 | *
10 | * **Default**: Colocated with its input schema.
11 | */
12 | outDir?: string | undefined;
13 | }
14 |
15 | const integration = (settings: Settings = {}): AstroIntegration => ({
16 | name: 'content-validator',
17 | hooks: {
18 | 'astro:server:setup': async ({ server }) => {
19 | const { generateChecker, generateAllCheckers } = await import(
20 | './schema-to-validator.js'
21 | );
22 |
23 | await generateAllCheckers(settings.outDir);
24 |
25 | server.watcher.on('all', (_, filePath: string) => {
26 | if (filePath.endsWith('.schema.yaml')) {
27 | generateChecker(filePath, settings.outDir).catch((e) =>
28 | console.log(e),
29 | );
30 | }
31 | });
32 | },
33 | },
34 | });
35 |
36 | export { integration };
37 |
--------------------------------------------------------------------------------
/packages/validator/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@astro-content/validator",
3 | "version": "0.0.0-alpha.16",
4 | "description": "",
5 | "keywords": [
6 | "astro",
7 | "astro-integration",
8 | "json-schema",
9 | "typecheck",
10 | "validator",
11 | "runtime",
12 | "frontmatter",
13 | "markdown"
14 | ],
15 | "homepage": "https://astro-content.dev",
16 | "repository": {
17 | "type": "git",
18 | "url": "https://github.com/JulianCataldo/astro-content",
19 | "directory": "packages/validator"
20 | },
21 | "license": "ISC",
22 | "author": "Julian Cataldo",
23 | "type": "module",
24 | "main": "./dist/index.js",
25 | "bin": {
26 | "content-validator": "./dist/cli.js"
27 | },
28 | "files": [
29 | "dist/*"
30 | ],
31 | "scripts": {
32 | "build": "tsc",
33 | "clean": "rm -rf dist .turbo",
34 | "dev": "tsc -w",
35 | "test": "echo \"Error: no test specified\" && exit 1"
36 | },
37 | "dependencies": {
38 | "@apidevtools/json-schema-ref-parser": "^9.0.9",
39 | "ajv": "^8.11.0",
40 | "ajv-formats": "^2.1.1",
41 | "change-case": "^4.1.2",
42 | "glob-promise": "^5.0.0",
43 | "json-schema-faker": "0.5.0-rcv.46",
44 | "json-schema-to-typescript": "^11.0.2",
45 | "lodash-es": "^4.17.21",
46 | "yaml": "^2.1.3"
47 | },
48 | "devDependencies": {
49 | "astro": "^1.6.10",
50 | "json-schema": "^0.4.0",
51 | "typescript": "^4.8.4"
52 | },
53 | "publishConfig": {
54 | "access": "public"
55 | },
56 | "// source": "./index.ts"
57 | }
58 |
--------------------------------------------------------------------------------
/packages/validator/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "ESNext",
4 | "module": "ESNext",
5 |
6 | "moduleResolution": "node",
7 | // Enable JSON imports.
8 | "resolveJsonModule": true,
9 |
10 | "isolatedModules": true,
11 |
12 | "types": ["node"],
13 |
14 | "baseUrl": ".",
15 |
16 | "allowSyntheticDefaultImports": true,
17 |
18 | "noImplicitAny": true,
19 |
20 | "strictNullChecks": true,
21 |
22 | "importsNotUsedAsValues": "error",
23 |
24 | "declaration": true,
25 |
26 | "outDir": "./dist"
27 | },
28 |
29 | "include": ["./index.ts", "./cli.ts"]
30 | }
31 |
--------------------------------------------------------------------------------
/pnpm-workspace.yaml:
--------------------------------------------------------------------------------
1 | packages:
2 | # - 'demo'
3 | - 'docs'
4 | - 'packages/*'
5 |
--------------------------------------------------------------------------------
/stylelint.config.cjs:
--------------------------------------------------------------------------------
1 | /** @type {import("@types/stylelint").Options} */
2 |
3 | module.exports = {
4 | /**
5 | * Reference:
6 | *
7 | * https://github.com/JulianCataldo/web-garden/blob/develop/configs/stylelint-all.cjs
8 | *
9 | * */
10 | extends: ['webdev-configs/stylelint-all.cjs'],
11 |
12 | rules: {
13 | /* NOTE: For VS Code colors variables */
14 | 'custom-property-pattern': null,
15 | // 'custom-selector-pattern': null,
16 | },
17 | };
18 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | // Enable top-level await, and other modern ESM features.
4 | "target": "ESNext",
5 | "module": "ESNext",
6 | // Enable node-style module resolution, for things like npm package imports.
7 | "moduleResolution": "node",
8 | // Enable JSON imports.
9 | "resolveJsonModule": true,
10 | // Enable stricter transpilation for better output.
11 | "isolatedModules": true,
12 | // Add type definitions for our Astro runtime.
13 | "types": [
14 | //
15 | "astro/client",
16 | "node"
17 | ],
18 |
19 | "baseUrl": ".",
20 |
21 | // "jsx": "react-jsxdev",
22 |
23 | "allowSyntheticDefaultImports": true,
24 |
25 | "noImplicitAny": true,
26 |
27 | "strictNullChecks": true,
28 |
29 | "importsNotUsedAsValues": "error",
30 |
31 | "noEmit": true,
32 |
33 | // "noEmitOnError": false,
34 | // "outDir": "./dist"
35 |
36 | "paths": {
37 | "/content": ["./docs/content"]
38 | }
39 | }
40 |
41 | // "include": ["./packages/integration/astro-integration.ts"]
42 | // "exclude": ["./**/node_modules/*"]
43 | }
44 |
--------------------------------------------------------------------------------
/turbo.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://turborepo.org/schema.json",
3 | "pipeline": {
4 | "build": {
5 | "dependsOn": ["^build"],
6 |
7 | "outputs": ["dist/**"]
8 | },
9 | "dev": {
10 | "cache": false
11 | },
12 | "clean": {
13 | "cache": false
14 | }
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
25 |