@code-ui/docstring - npm Package Compare versions

Comparing version 0.0.9 to 0.0.10

dist/index.d.ts

 export * from "./lib";
+export * from "./lib/type";

dist/index.js

@@ -14,2 +14,3 @@ "use strict";
 __exportStar(require("./lib"), exports);
+__exportStar(require("./lib/type"), exports);
 //# sourceMappingURL=index.js.map

dist/lib/field/field.d.ts

 /// <reference types="react" />
-import { IField } from "./type";
+import { IField } from "../type";
 interface Props<T = string> {
@@ -4,0 +4,0 @@ field: IField;

dist/lib/field/field.js

@@ -8,11 +8,11 @@ "use strict";
 const styled_1 = __importDefault(require("@emotion/styled"));
-const drop_down_1 = __importDefault(require("../drop-down"));
 const handlebars_1 = __importDefault(require("handlebars"));
-const valuefield = /{{\s?options\s?}}/;
-const defaulttemplate = "{{tag}}{{name}} {{ options }}";
+const token_1 = require("@code-ui/token");
+const valueField = /{{\s?options\s?}}/;
+const defaultTemplate = "{{tag}}{{name}} {{ options }}";
 const field = (props) => {
     var _a;
-    const template = (_a = props.field.template) !== null && _a !== void 0 ? _a : defaulttemplate;
+    const template = (_a = props.field.template) !== null && _a !== void 0 ? _a : defaultTemplate;
     const field = props.field;
-    const _splits = template.split(valuefield);
+    const _splits = template.split(valueField);
     const __splits_1 = _splits[0];
@@ -28,6 +28,5 @@ const __splits_3 = _splits[1];
         "\u00A0",
-        _2 && field.options &&
-            react_1.default.createElement(drop_down_1.default, { id: field.name, items: field.options, onSelect: (d) => {
-                    props.onChange(field.name, d);
-                } }),
+        _2 && field.options && (react_1.default.createElement(token_1.DropDown, { id: field.name, items: field.options, onSelect: (d) => {
+                props.onChange(field.name, d);
+            } })),
         "\u00A0",
@@ -34,0 +33,0 @@ _3 && react_1.default.createElement(Label, null, _3)));

dist/lib/index.d.ts

 /// <reference types="react" />
 import { CodeLikeViewProps } from "./type";
-export declare const CodeLikeView: (props: CodeLikeViewProps) => JSX.Element;
+export declare const Docstring: (props: CodeLikeViewProps) => JSX.Element;

dist/lib/index.js

@@ -6,13 +6,14 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CodeLikeView = void 0;
+exports.Docstring = void 0;
 const field_1 = __importDefault(require("./field"));
 const react_1 = __importDefault(require("react"));
-const code_coment_1 = __importDefault(require("./code-coment"));
+const token_1 = require("@code-ui/token");
 const type_1 = require("./type");
 const style_1 = require("./style");
 const react_2 = require("@emotion/react");
-const CodeLikeView = (props) => {
+const color_scheme_1 = require("@code-ui/color-scheme");
+const Docstring = (props) => {
     var _a;
     const expandableConfig = props === null || props === void 0 ? void 0 : props.expandableConfig;
-    const langconfig = type_1._language_config((_a = props.lang) !== null && _a !== void 0 ? _a : "js");
+    const langconfig = _language_config((_a = props.lang) !== null && _a !== void 0 ? _a : "js");
     const lines = props.controls.length; // TODO: make state
@@ -23,14 +24,31 @@ const onChange = props.onChange;
     // };
-    return (react_1.default.createElement(react_2.ThemeProvider, { theme: style_1.Monokai },
+    function _language_config(type) {
+        if (typeof type == "string") {
+            if (type === "js") {
+                return type_1._DEFAULT_JS_STYLE;
+            }
+            else if (type === "dart") {
+                return type_1._DEFAULT_DART;
+            }
+            //  TODO: add python preset
+            else {
+                throw `${type} is not a valid preset`;
+            }
+        }
+        else {
+            return type;
+        }
+    }
+    return (react_1.default.createElement(react_2.ThemeProvider, { theme: color_scheme_1.MonokaiDocstring },
         react_1.default.createElement(style_1.CodeWrapper, { padding: props.padding },
-            react_1.default.createElement(code_coment_1.default, { docstring: langconfig.docstring.start, indent: langconfig.indent.start }),
+            react_1.default.createElement(token_1.CodeComent, { docstring: langconfig.docstring.start, indent: langconfig.indent.start }),
             props.controls.map((field, i) => {
-                return (react_1.default.createElement(style_1.Line, null,
-                    react_1.default.createElement(code_coment_1.default, { docstring: langconfig.docstring.mid, indent: langconfig.indent.mid }),
+                return (react_1.default.createElement(style_1.Line, { key: `line-number-${i}` },
+                    react_1.default.createElement(token_1.CodeComent, { docstring: langconfig.docstring.mid, indent: langconfig.indent.mid }),
                     react_1.default.createElement(field_1.default, { field: field, onChange: onChange })));
             }),
             react_1.default.createElement(react_1.default.Fragment, null,
-                react_1.default.createElement(code_coment_1.default, { docstring: langconfig.docstring.end, indent: langconfig.indent.end })))));
+                react_1.default.createElement(token_1.CodeComent, { docstring: langconfig.docstring.end, indent: langconfig.indent.end })))));
 };
-exports.CodeLikeView = CodeLikeView;
+exports.Docstring = Docstring;
 //# sourceMappingURL=index.js.map

dist/lib/style/style.d.ts

 /// <reference types="react" />
 import { Theme } from "@emotion/react";
-declare type _Color = string;
+import { DocstringColorTheme } from "@code-ui/color-scheme";
 declare module "@emotion/react" {
-    interface Theme extends DocstringTheme {
+    interface Theme extends DocstringColorTheme {
     }
@@ -23,22 +23,1 @@ }
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
-interface DocstringTheme {
-    highlight: {
-        text: {
-            color: _Color;
-        };
-        bg: {
-            color: _Color;
-        };
-    };
-    comment: {
-        color: _Color;
-    };
-    link: {
-        color: _Color;
-    };
-    bg: {
-        color: _Color;
-    };
-}
-export declare const Monokai: DocstringTheme;
-export {};

dist/lib/style/style.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Monokai = exports.Link = exports.CodeWrapper = exports.Line = void 0;
+exports.Link = exports.CodeWrapper = exports.Line = void 0;
 const styled_1 = __importDefault(require("@emotion/styled"));
@@ -29,11 +29,2 @@ exports.Line = styled_1.default.div `
 `;
-exports.Monokai = {
-    highlight: {
-        text: { color: "#D7D7D7" },
-        bg: { color: "#3A3842" },
-    },
-    comment: { color: "#868686" },
-    link: { color: "#868686" },
-    bg: { color: "#2A2734" },
-};
 //# sourceMappingURL=style.js.map

dist/lib/type.d.ts

@@ -1,18 +0,13 @@
-import { IField } from "./field/type";
-interface LanguageConfig {
-    docstring: {
-        start: string;
-        mid?: string;
-        end: string;
-    };
-    indent: {
-        start?: number;
-        mid?: number;
-        end: number;
-    };
+import { LanguageConfig, ExpandableConfig } from "@code-ui/core";
+export interface Option<T> {
+    name: string;
+    value: T;
+    description?: string;
 }
-export interface ExpandableConfig {
-    lines: number;
-    expandable: boolean;
-    hidable?: boolean;
+export interface IField<T = string> {
+    tag?: "@";
+    name: string;
+    enabled?: boolean;
+    template?: string;
+    options?: Option<T>[];
 }
@@ -27,6 +22,4 @@ export interface CodeLikeViewProps<T = string> {
 }
-export declare const _DEFAULT_JSS_STYLE: LanguageConfig;
+export declare const _DEFAULT_JS_STYLE: LanguageConfig;
 export declare const _DEFAULT_DART: LanguageConfig;
 export declare type LanguageType = "js" | "dart" | "paython" | LanguageConfig;
-export declare function _language_config(type: LanguageType): LanguageConfig;
-export {};

dist/lib/type.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._language_config = exports._DEFAULT_DART = exports._DEFAULT_JSS_STYLE = void 0;
-exports._DEFAULT_JSS_STYLE = {
+exports._DEFAULT_DART = exports._DEFAULT_JS_STYLE = void 0;
+exports._DEFAULT_JS_STYLE = {
     docstring: {
@@ -26,20 +26,2 @@ start: "/**",
 };
-function _language_config(type) {
-    if (typeof type == "string") {
-        if (type === "js") {
-            return exports._DEFAULT_JSS_STYLE;
-        }
-        else if (type === "dart") {
-            return exports._DEFAULT_DART;
-        }
-        //  TODO: add python preset
-        else {
-            throw `${type} is not a valid preset`;
-        }
-    }
-    else {
-        return type;
-    }
-}
-exports._language_config = _language_config;
 //# sourceMappingURL=type.js.map

package.json

 {
   "name": "@code-ui/docstring",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "repository": "https://github.com/gridaco/code-like-ui/tree/main/packages/docstring",
@@ -18,2 +18,5 @@ "homepage": "https://github.com/gridaco/code-like-ui",
   },
+  "dependencies": {
+    "@code-ui/core": "0.0.0"
+  },
   "devDependencies": {
@@ -32,6 +35,2 @@ "@emotion/react": "^11.4.1",
   },
-  "dependencies": {
-    "@tippyjs/react": "^4.2.5",
-    "handlebars": "^4.7.7"
-  },
   "files": [
@@ -38,0 +37,0 @@ "README.md",

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dependency count

3

decreased by-25%

Worsened metrics

Total package byte prevSize

23592

decreased by-25.48%

Number of package files

17

decreased by-45.16%

Lines of code

238

decreased by-50.52%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@code-ui/core@0.0.0

• + Added@code-ui/core@0.0.0(transitive)

• - Removed@tippyjs/react@^4.2.5

• - Removedhandlebars@^4.7.7

• - Removed@popperjs/core@2.11.8(transitive)

• - Removed@tippyjs/react@4.2.6(transitive)

• - Removedhandlebars@4.7.8(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedneo-async@2.6.2(transitive)

• - Removedsource-map@0.6.1(transitive)

• - Removedtippy.js@6.3.7(transitive)

• - Removeduglify-js@3.19.3(transitive)

• - Removedwordwrap@1.0.0(transitive)