@docusaurus/types - npm Package Compare versions

Comparing version 2.0.0-alpha.08f6734bf to 2.0.0-alpha.0a75ed5d4

package.json

 {
   "name": "@docusaurus/types",
-  "version": "2.0.0-alpha.08f6734bf",
-  "description": "Common used typings for Docusaurus packages",
+  "version": "2.0.0-alpha.0a75ed5d4",
+  "description": "Common types for Docusaurus packages.",
   "main": "./src/index.js",
@@ -22,3 +22,3 @@ "types": "./src/index.d.ts",
   },
-  "gitHead": "904e782230bc8377410f408cfc6aecdbd1e02c86"
+  "gitHead": "27f4501c67cba3357b05988d436d0fac4b7658ce"
 }

src/index.d.ts

@@ -10,3 +10,3 @@ /**
 // eslint-disable-next-line import/no-extraneous-dependencies
-import {Loader, Configuration} from 'webpack';
+import {Loader, Configuration, Stats} from 'webpack';
 import {Command} from 'commander';
@@ -96,5 +96,10 @@ import {ParsedUrlQueryInput} from 'querystring';
 
+export type I18nLocaleConfig = {
+  label: string;
+};
+
 export type I18nConfig = {
   defaultLocale: string;
   locales: [string, ...string[]];
+  localeConfigs: Record<string, I18nLocaleConfig>;
 };
@@ -178,2 +183,9 @@
 
+/**
+ * Same as `Props` but also has webpack stats appended.
+ */
+export interface PropsPostBuild extends Props {
+  stats: Stats.ToJsonOutput;
+}
+
 export interface PluginContentLoadedActions {
@@ -207,3 +219,3 @@ addRoute(config: RouteConfig): void;
   routesLoaded?(routes: RouteConfig[]): void; // TODO remove soon, deprecated (alpha-60)
-  postBuild?(props: Props): void;
+  postBuild?(props: PropsPostBuild): void;
   postStart?(props: Props): void;
@@ -226,2 +238,3 @@ configureWebpack?(
   getSwizzleComponentList?(): string[];
+  // TODO before/afterDevServer implementation
 
@@ -352,6 +365,6 @@ // translations
 
-export interface MarkdownRightTableOfContents {
+export interface TOCItem {
   readonly value: string;
   readonly id: string;
-  readonly children: MarkdownRightTableOfContents[];
+  readonly children: TOCItem[];
 }

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11048

increased by3.03%

Number of package files

5

increased by25%

Lines of code

329

increased by3.46%

Number of medium quality alerts

0

decreased by-100%

Number of lines in readme file

4

increased byInfinity%

No dependency changes