@berqnet/theme 0.0.0-stage → 2.4.292

package/README.md

@@ -1,3 +1,112 @@
-# Temporary Holding Version
+# @berqnet/theme
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Nuxt module for Theme Installation.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Scripts](#scripts)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To install this module, you can use npm or yarn:
+
+### npm
+
+```sh
+npm install @berqnet/theme
+```
+
+### yarn
+
+```sh
+yarn add @berqnet/theme
+```
+
+## Usage
+
+1. To use this module in your Nuxt 3 project, add it to your `nuxt.config.ts`:
+
+```typescript
+export default defineNuxtConfig({
+  modules: ['@berqnet/theme'],
+});
+```
+
+2. Add below code to your **tailwind.config.js** file
+
+```js
+// tint & shade color generator
+function generateColors(baseName, start = 1, end = 9, step = 1) {
+  const colors = {};
+
+  for (let i = start; i <= end; i += step) {
+    colors[i] = `var(--el-color-${baseName}-light-${i})`;
+  }
+
+  return colors;
+}
+
+const colorNames = ['primary', 'secondary', 'neutral', 'danger', 'success', 'warning', 'info'];
+const colorShades = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+const classPrefixes = ['bg', 'text', 'border'];
+const colors = colorNames.reduce((acc, color) => ({ ...acc, [`${color}`]: generateColors(color, 1, 9) }), {});
+
+module.exports = {
+  // content: ['./pages/**/*.{vue,html}', './components/**/*.{vue,html}', './layouts/**/*.{vue,html}', './modules/**/*.{vue,html}'],
+  content: ['./modules/**/*.{vue,html}'],
+  theme: {
+    extend: {
+      colors,
+      spacing: {
+        default: '30px',
+        7.5: '30px', // 30px için özel bir sınıf ekliyoruz
+      },
+    },
+  },
+  plugins: [
+    function ({ addUtilities, theme, e }) {
+      const gridCols = theme('gridTemplateColumns');
+      const utilities = Object.entries(gridCols).map(([key, value]) => ({
+        [`.${e(`grid-cols-${key}`)}`]: {
+          'grid-template-columns': value,
+          gap: '30px', // Burada varsayılan boşluğu ayarlıyoruz
+        },
+      }));
+
+      addUtilities(utilities);
+    },
+  ],
+  safelist: classPrefixes.flatMap((prefix) => colorNames.flatMap((color) => colorShades.map((i) => `${prefix}-${color}-${i}`))),
+};
+```
+
+## Scripts
+
+The following npm scripts are available:
+
+- `test`: Run tests using Vitest.
+- `test:watch`: Run tests in watch mode.
+- `test:types`: Check TypeScript types.
+- `lint:prettier`: Lint code using Prettier.
+- `lint:eslint`: Lint code using ESLint.
+- `lint:stylelint`: Lint styles using Stylelint.
+- `fix`: Fix linting errors.
+- `pub`: Publish the module.
+- `release`: Release a new version.
+
+## Contributing
+
+If you would like to contribute, please follow these guidelines:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Commit your changes.
+4. Push your branch and create a pull request.
+
+## License
+
+This project is licensed under the MIT License.

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,12 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { ModuleOptions } from 'nuxt/schema';
+
+interface MyModuleOptions extends ModuleOptions {
+    moduleName: string;
+    version: string;
+    description: string;
+}
+declare const _default: _nuxt_schema.NuxtModule<MyModuleOptions, MyModuleOptions, false>;
+
+export { _default as default };
+export type { MyModuleOptions };

package/dist/module.d.ts

@@ -0,0 +1,12 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { ModuleOptions } from 'nuxt/schema';
+
+interface MyModuleOptions extends ModuleOptions {
+    moduleName: string;
+    version: string;
+    description: string;
+}
+declare const _default: _nuxt_schema.NuxtModule<MyModuleOptions, MyModuleOptions, false>;
+
+export { _default as default };
+export type { MyModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "@berqnet/theme",
+  "configKey": "themeOptions",
+  "version": "2.4.291",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "2.0.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,194 @@
+import { resolve } from 'node:path';
+import { defineNuxtModule, createResolver, useNuxt, addImportsDir, addPlugin } from '@nuxt/kit';
+
+
+
+// -- Unbuild CommonJS Shims --
+import __cjs_url__ from 'url';
+import __cjs_path__ from 'path';
+import __cjs_mod__ from 'module';
+const __filename = __cjs_url__.fileURLToPath(import.meta.url);
+const __dirname = __cjs_path__.dirname(__filename);
+const require = __cjs_mod__.createRequire(import.meta.url);
+const name = "@berqnet/theme";
+const version = "2.4.291";
+const description = "A comprehensive Nuxt.js module providing a tailored theme experience with integrated TailwindCSS support for applications.";
+const type = "module";
+const exports = {
+	".": {
+		types: "./dist/types.d.ts",
+		"import": "./dist/module.mjs",
+		require: "./dist/module.cjs"
+	}
+};
+const main = "./dist/module.cjs";
+const types = "./dist/types.d.ts";
+const files = [
+	"dist"
+];
+const scripts = {
+	test: "vitest run",
+	"test:watch": "vitest watch",
+	"test:types": "vue-tsc --noEmit",
+	"lint:prettier": "npx prettier --write --list-different \"{**/*.js,**/*.vue,**/*.scss,!(node*)**/*.js}\"",
+	"lint:eslint": "eslint --ext \".js,.ts,.vue,.json\" .",
+	"lint:stylelint": "stylelint \"**/*.{scss,sass,html,vue}\"",
+	fix: "npm run lint:prettier && npm run lint:eslint -- --fix && npm run lint:stylelint -- --fix",
+	pub: "npm publish",
+	sass: "node generate-sass.js",
+	"clean-composables": "node remove-composable.js",
+	build: "nuxt-module-build build && npm run clean-composables",
+	version: "commit-and-tag-version --release-as ${npm_config_type:-patch}",
+	release: "npm run build && npm run version && npm run pub && git push --follow-tags origin main"
+};
+const repository = {
+	type: "git",
+	url: "https://berqnet.ghe.com/berqnet/design-system.git"
+};
+const keywords = [
+	"nuxt",
+	"nuxt3",
+	"module",
+	"component",
+	"vue",
+	"vue3",
+	"theme",
+	"tailwind"
+];
+const peerDependencies = {
+	vue: "^3.x"
+};
+const author = "Berqnet";
+const license = "MIT";
+const dependencies = {
+	"@nuxt/kit": "*",
+	tailwindcss: "*",
+	"vue-tsc": "^2.0.29"
+};
+const devDependencies = {
+	sass: "*"
+};
+const publishConfig = {
+	access: "public"
+};
+const PackageJson = {
+	name: name,
+	version: version,
+	description: description,
+	type: type,
+	exports: exports,
+	main: main,
+	types: types,
+	files: files,
+	scripts: scripts,
+	"commit-and-tag-version": {
+	tagPrefix: "theme-v",
+	releaseCommitMessageFormat: "chore(release): @berqnet/theme {{currentTag}}",
+	types: [
+		{
+			type: "build",
+			section: "Build System",
+			hidden: true
+		}
+	],
+	"release-as": "patch"
+},
+	repository: repository,
+	keywords: keywords,
+	peerDependencies: peerDependencies,
+	author: author,
+	license: license,
+	dependencies: dependencies,
+	devDependencies: devDependencies,
+	publishConfig: publishConfig
+};
+
+const folderPath = "./runtime";
+const DEV_LAYOUT_NAME = "berqnet-modules";
+const module = defineNuxtModule({
+  meta: {
+    name: PackageJson.name,
+    configKey: "themeOptions"
+  },
+  defaults: {
+    moduleName: PackageJson.name,
+    version: PackageJson.version,
+    description: PackageJson.description
+  },
+  hooks: {
+    "pages:extend": (pages) => {
+      const resolver = createResolver(import.meta.url);
+      const nuxt = useNuxt();
+      const isDev = nuxt.options.dev;
+      if (isDev) {
+        pages.push({
+          name: "theme",
+          path: "/theme",
+          mode: "client",
+          file: resolver.resolve(`${folderPath}/pages/theme.vue`)
+        });
+        pages.push({
+          name: "colors",
+          path: "/colors",
+          mode: "client",
+          file: resolver.resolve(`${folderPath}/pages/colors.vue`)
+        });
+      }
+    },
+    "nitro:config": async (nitroConfig) => {
+      nitroConfig.publicAssets ||= [];
+      nitroConfig.publicAssets.push({
+        dir: resolve(__dirname, `${folderPath}/public`),
+        maxAge: 60 * 60 * 24 * 365
+        // 1 year
+      });
+      nitroConfig.prerender = {
+        ...nitroConfig.prerender,
+        ...{ failOnError: false }
+      };
+    }
+  },
+  setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url);
+    const isDev = nuxt.options.dev;
+    console.info(`'${PackageJson.name}' loaded. Version:${options.version}`);
+    addImportsDir(resolver.resolve("runtime/composables"));
+    const components_dir_list = [
+      { env: "development", path: `${folderPath}/components/development` },
+      { env: "production", path: `${folderPath}/components/production` }
+    ];
+    nuxt.hook("components:dirs", (dirs) => {
+      components_dir_list.forEach(({ env, path }) => {
+        if (isDev || env === "production") {
+          dirs.push({
+            path: resolver.resolve(path)
+            /* , prefix: 'my-module' */
+          });
+        }
+      });
+    });
+    if (isDev) {
+      nuxt.hook("app:templates", (app) => {
+        if (!app.layouts[DEV_LAYOUT_NAME]) {
+          app.layouts[DEV_LAYOUT_NAME] = {
+            name: DEV_LAYOUT_NAME,
+            file: resolver.resolve(`${folderPath}/layouts/${DEV_LAYOUT_NAME}.vue`)
+          };
+        }
+      });
+    }
+    addPlugin(resolver.resolve(`${folderPath}/plugins/sample-plugin`));
+    addPlugin(resolver.resolve(`${folderPath}/plugins/disable-warnings-plugin`));
+    addPlugin(resolver.resolve(`${folderPath}/plugins/theme-provider-plugin`));
+    nuxt.options.runtimeConfig.public.theme = {
+      ...options
+    };
+    nuxt.options.css.push(resolver.resolve(`${folderPath}/public/scss/theme.scss`));
+    nuxt.options.css.push(resolver.resolve(`${folderPath}/public/scss/element-plus/index.scss`));
+    nuxt.hook("prepare:types", ({ references }) => {
+      references.push({ path: resolver.resolve(`${folderPath}/types.d.ts`) });
+    });
+  }
+});
+
+export { module as default };