@apocrypha/core - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

catalog.d.ts

@@ -1,8 +0,5 @@
-import type {Article} from './src/framework';
+import type { Article } from './src/framework';
 
 export function useArticle<TMeta extends object>(path: string): Article<TMeta>;
-export function useCatalog<TMeta extends object>(): Record<
-  string,
-  Article<TMeta>
->;
+export function useCatalog<TMeta extends object>(): Record<string, Article<TMeta>>;
 
@@ -9,0 +6,0 @@ export function getArticleModuleUrl(path: string): string;

dist/constants.d.ts

 export declare const ARTICLE_FILENAME_PATTERN: RegExp;
-export declare const ASSETS_MODULE_NAME = "@apocrypha/assets";
-export declare const CATALOG_MODULE_NAME = "@apocrypha/catalog";
-export declare const COMPONENTS_MODULE_NAME = "@apocrypha/components";
-export declare const CONFIG_MODULE_NAME = "@apocrypha/config";
+export declare const ASSETS_MODULE_NAME = "@apocrypha/core/assets";
+export declare const CATALOG_MODULE_NAME = "@apocrypha/core/catalog";
+export declare const COMPONENTS_MODULE_NAME = "@apocrypha/core/components";
+export declare const CONFIG_MODULE_NAME = "@apocrypha/core/config";
 export declare const MANIFEST_MODULE_NAME = "article-manifest.js";

package.json

 {
   "name": "@apocrypha/core",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "an engine for building websites with vite and markdoc",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -48,3 +48,3 @@ ![apocrypha](https://github.com/nkohari/apocrypha/assets/1576/3f30609e-2b2f-465d-b61e-fe101e370672)
 ```ts
-import {useCatalog} from '@apocrypha/catalog';
+import {useCatalog} from '@apocrypha/core/catalog';
 
@@ -65,3 +65,3 @@ export const ArticleList = () => {
 
-(The `@apocrypha/catalog` module isn't actually part of the Apocrypha library; it's a _virtual module_ which is generated at build time for your project.)
+(The `@apocrypha/core/catalog` module isn't actually part of the Apocrypha library; it's a _virtual module_ which is generated at build time for your project.)
 
@@ -71,3 +71,3 @@ To display an article's content, you can use the `ArticleContent` component. This is a React component which can asynchronously load the article's module and render its content using the Markdoc React renderer. The `ArticleContent` component is designed to work with [`<Suspense>`](https://react.dev/reference/react/Suspense) boundaries, which you can use to show a loading indicator. Here's an example:
 ```ts
-import {ArticleContent} from '@apocrypha/catalog';
+import {ArticleContent} from '@apocrypha/core/catalog';
 
@@ -88,3 +88,3 @@ type PageProps = {
 ```ts
-import {ArticleContent} from '@apocrypha/catalog';
+import {ArticleContent} from '@apocrypha/core/catalog';
 
@@ -91,0 +91,0 @@ type PageProps = {

src/constants.ts

 export const ARTICLE_FILENAME_PATTERN = /\.md/;
-export const ASSETS_MODULE_NAME = '@apocrypha/assets';
-export const CATALOG_MODULE_NAME = '@apocrypha/catalog';
-export const COMPONENTS_MODULE_NAME = '@apocrypha/components';
-export const CONFIG_MODULE_NAME = '@apocrypha/config';
+export const ASSETS_MODULE_NAME = '@apocrypha/core/assets';
+export const CATALOG_MODULE_NAME = '@apocrypha/core/catalog';
+export const COMPONENTS_MODULE_NAME = '@apocrypha/core/components';
+export const CONFIG_MODULE_NAME = '@apocrypha/core/config';
 export const MANIFEST_MODULE_NAME = 'article-manifest.js';

No alert changes

Improved metrics

Total package byte prevSize

3441352

Worsened metrics

Lines of code

35887

decreased by-0.01%

No dependency changes