npm - @ronas-it/nx-generators - Versions diffs - 0.3.8 → 0.4.0 - Mend

@ronas-it/nx-generators 0.3.8 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/generators.json CHANGED Viewed

@@ -10,6 +10,11 @@
       "schema": "./src/generators/expo-app/schema.json",
       "description": "expo-app generator"
     },
+    "next-app": {
+      "factory": "./src/generators/next-app/generator",
+      "schema": "./src/generators/next-app/schema.json",
+      "description": "next-app generator"
+    },
     "repo-config": {
       "factory": "./src/generators/repo-config/generator",
       "schema": "./src/generators/repo-config/schema.json",

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@ronas-it/nx-generators",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "NX generators for Ronas IT projects",
   "license": "MIT",
   "author": "Ronas IT",

package/src/generators/next-app/files/.env.development.template ADDED Viewed

	@@ -0,0 +1 @@
1	+ NEXT_PUBLIC_APP_ENV=development

package/src/generators/next-app/files/.env.production.template ADDED Viewed

	@@ -0,0 +1 @@
1	+ NEXT_PUBLIC_APP_ENV=production

package/src/generators/next-app/files/.env.template ADDED Viewed

	@@ -0,0 +1 @@
1	+ NEXT_PUBLIC_APP_ENV=development

package/src/generators/next-app/files/README.md.template ADDED Viewed

@@ -0,0 +1,39 @@
+# <%= formatName(name) %> - Next.js app
+This is a web app built with Next.js.
+## Tasks overview
+You can run tasks for this project with:
+```sh
+npx nx <task-name> <%= name %>
+```
+To view the list of available tasks, run:
+```sh
+npx nx show project <%= name %> --web
+```
+The following tasks are included by default:
+- `dev` – Start the local development server.
+- `build` – Create a production build.
+- `start` – Create and start a production build.
+- `lint` – Check the source code with `eslint`.
+## Development
+To run this application locally, follow these steps:
+```sh
+# 1. Navigate to Nx workspace directory containing this app
+cd <path-to-nx-workspace>
+# 2. Install dependencies
+npm install
+# 3. Start the local development server
+npx nx dev <%= name %>
+```

package/src/generators/next-app/files/app/[locale]/layout.tsx.template ADDED Viewed

@@ -0,0 +1,48 @@
+import { constants, Locale } from '../../constants';
+import { notFound } from 'next/navigation';
+import { unstable_setRequestLocale } from 'next-intl/server';
+import { ReactElement, ReactNode } from 'react';
+import { Providers } from './providers';
+export const metadata = {
+  title: '<%= formatName(name) %>',
+};
+export interface RootLayoutProps {
+  children: ReactNode;
+  params: { locale: Locale };
+}
+const locales = constants.locales;
+export const generateStaticParams = (): Array<{ locale: Locale }> =>
+  locales.map((locale) => ({ locale }));
+export default function RootLayout({
+  children,
+  params: { locale },
+}: RootLayoutProps): ReactElement {
+  if (!locales.includes(locale)) {
+    notFound();
+  }
+  unstable_setRequestLocale(locale);
+  return (
+    <html lang={locale}>
+      <head>
+        <meta
+          name="robots"
+          content={
+            process.env.NEXT_PUBLIC_APP_ENV === 'production'
+              ? 'index'
+              : 'noindex'
+          }
+        />
+      </head>
+      <body>
+        <Providers>{children}</Providers>
+      </body>
+    </html>
+  );
+}

package/src/generators/next-app/files/app/[locale]/page.tsx.template ADDED Viewed

@@ -0,0 +1,18 @@
+import { ReactElement } from 'react';
+import { Locale } from '../../constants';
+import { unstable_setRequestLocale } from 'next-intl/server';
+import { useTranslations } from 'next-intl';
+export interface IndexPageProps {
+  params: { locale: Locale };
+}
+export default function Index({
+  params: { locale },
+}: IndexPageProps): ReactElement {
+  unstable_setRequestLocale(locale);
+  const t = useTranslations('HOME_PAGE');
+  return <div>{t('HOME_PAGE_TEXT')}</div>;
+}

package/src/generators/next-app/files/app/[locale]/providers.tsx.template ADDED Viewed

@@ -0,0 +1,16 @@
+import { ReactElement } from 'react';
+import { NextIntlClientProvider, useMessages } from 'next-intl';
+export function Providers({
+  children,
+}: {
+  children: React.ReactNode;
+}): ReactElement {
+  const messages = useMessages();
+  return (
+    <NextIntlClientProvider messages={messages}>
+      {children}
+    </NextIntlClientProvider>
+  );
+}

package/src/generators/next-app/files/constants.ts.template ADDED Viewed

@@ -0,0 +1,11 @@
+export type Locale = 'en';
+interface Constants {
+  defaultLocale: Locale;
+  locales: Array<Locale>;
+}
+export const constants: Constants = {
+  defaultLocale: 'en',
+  locales: ['en'],
+};

package/src/generators/next-app/files/i18n/en.json.template ADDED Viewed

@@ -0,0 +1,5 @@
+{
+  "HOME_PAGE": {
+    "HOME_PAGE_TEXT": "<%= formatName(name) %> home page"
+  }
+}

package/src/generators/next-app/files/i18n.ts.template ADDED Viewed

@@ -0,0 +1,13 @@
+import { notFound } from 'next/navigation';
+import { getRequestConfig } from 'next-intl/server';
+import { constants, Locale } from './constants';
+export default getRequestConfig(async ({ locale }) => {
+  if (!constants.locales.includes(locale as Locale)) {
+    notFound();
+  }
+  return {
+    messages: (await import(`./i18n/${locale}.json`)).default,
+  };
+});

package/src/generators/next-app/files/middleware.ts.template ADDED Viewed

@@ -0,0 +1,12 @@
+import { constants } from './constants';
+import createMiddleware from 'next-intl/middleware';
+export default createMiddleware({
+  locales: constants.locales,
+  defaultLocale: constants.defaultLocale,
+  localePrefix: 'never',
+});
+export const config = {
+  matcher: ['/((?!api|_next|.*\\..*).*)'],
+};

package/src/generators/next-app/files/next.config.js.template ADDED Viewed

@@ -0,0 +1,19 @@
+const { withNx } = require('@nrwl/next/plugins/with-nx');
+const withNextIntl = require('next-intl/plugin')();
+/**
+ * @type {import('@nrwl/next/plugins/with-nx').WithNxOptions}
+ **/
+const nextConfig = {
+  nx: {
+    // Set this to true if you would like to use SVGR
+    // See: https://github.com/gregberge/svgr
+    svgr: false,
+  },
+  output: 'standalone',
+  async redirects() {
+    return [];
+  },
+};
+module.exports = withNx(withNextIntl(nextConfig));

package/src/generators/next-app/generator.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { NextAppGeneratorSchema } from './schema';
+export declare function nextAppGenerator(tree: Tree, options: NextAppGeneratorSchema): Promise<() => void>;
+export default nextAppGenerator;

package/src/generators/next-app/generator.js ADDED Viewed

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nextAppGenerator = void 0;
+const tslib_1 = require("tslib");
+const child_process_1 = require("child_process");
+const devkit_1 = require("@nx/devkit");
+const fs_1 = require("fs");
+const utils_1 = require("../../shared/utils");
+const path = require("path");
+const dependencies = {
+    'next-intl': '^3.17.2',
+};
+function nextAppGenerator(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const appRoot = `apps/${options.directory}`;
+        // Install @nx/next plugin
+        (0, child_process_1.execSync)('npx nx add @nx/next', { stdio: 'inherit' });
+        if (!(0, fs_1.existsSync)(appRoot)) {
+            (0, child_process_1.execSync)(`npx nx g @nx/next:app ${options.name} --directory=apps/${options.directory} --projectNameAndRootFormat=as-provided --appDir=true --style=scss --src=false --unitTestRunner=none --e2eTestRunner=none`, { stdio: 'inherit' });
+        }
+        // Remove unnecessary files and files that will be replaced
+        tree.delete(`${appRoot}/public/.gitkeep`);
+        tree.delete(`${appRoot}/app/api`);
+        tree.delete(`${appRoot}/app/page.tsx`);
+        tree.delete(`${appRoot}/app/page.module.scss`);
+        tree.delete(`${appRoot}/app/global.css`);
+        tree.delete(`${appRoot}/app/layout.tsx`);
+        tree.delete(`${appRoot}/.eslintrc.json`);
+        // Update app tsconfig.json to skip automatic reconfiguration during the first application run
+        const appTsconfigPath = `${appRoot}/tsconfig.json`;
+        const appTsconfigJson = (0, devkit_1.readJson)(tree, appTsconfigPath);
+        const nextTypesInclude = '.next/types/**/*.ts';
+        if (!appTsconfigJson.include.includes(nextTypesInclude)) {
+            appTsconfigJson.include.push(nextTypesInclude);
+            (0, devkit_1.writeJson)(tree, appTsconfigPath, appTsconfigJson);
+        }
+        // Add app files
+        (0, devkit_1.generateFiles)(tree, path.join(__dirname, 'files'), appRoot, Object.assign(Object.assign({}, options), { formatName: utils_1.formatName }));
+        // Add dependencies
+        (0, devkit_1.addDependenciesToPackageJson)(tree, dependencies, {});
+        yield (0, devkit_1.formatFiles)(tree);
+        return () => {
+            (0, devkit_1.installPackagesTask)(tree);
+        };
+    });
+}
+exports.nextAppGenerator = nextAppGenerator;
+exports.default = nextAppGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/next-app/generator.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/next-app/generator.ts"],"names":[],"mappings":";;;;AAAA,iDAAyC;AACzC,uCAQoB;AAEpB,2BAAgC;AAChC,8CAAgD;AAChD,6BAA6B;AAE7B,MAAM,YAAY,GAAG;IACnB,WAAW,EAAE,SAAS;CACvB,CAAC;AAEF,SAAsB,gBAAgB,CACpC,IAAU,EACV,OAA+B;;QAE/B,MAAM,OAAO,GAAG,QAAQ,OAAO,CAAC,SAAS,EAAE,CAAC;QAE5C,0BAA0B;QAC1B,IAAA,wBAAQ,EAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAA,eAAU,EAAC,OAAO,CAAC,EAAE,CAAC;YACzB,IAAA,wBAAQ,EACN,yBAAyB,OAAO,CAAC,IAAI,qBAAqB,OAAO,CAAC,SAAS,2HAA2H,EACtM,EAAE,KAAK,EAAE,SAAS,EAAE,CACrB,CAAC;QACJ,CAAC;QAED,2DAA2D;QAC3D,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,UAAU,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,eAAe,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,uBAAuB,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;QAEzC,8FAA8F;QAC9F,MAAM,eAAe,GAAG,GAAG,OAAO,gBAAgB,CAAC;QACnD,MAAM,eAAe,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACxD,MAAM,gBAAgB,GAAG,qBAAqB,CAAC;QAE/C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACxD,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC/C,IAAA,kBAAS,EAAC,IAAI,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QACpD,CAAC;QAED,gBAAgB;QAChB,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,kCACrD,OAAO,KACV,UAAU,EAAV,kBAAU,IACV,CAAC;QAEH,mBAAmB;QACnB,IAAA,qCAA4B,EAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QAErD,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC;CAAA;AAjDD,4CAiDC;AAED,kBAAe,gBAAgB,CAAC"}

package/src/generators/next-app/schema.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+export interface NextAppGeneratorSchema {
+  name: string;
+  directory: string;
+}

package/src/generators/next-app/schema.json ADDED Viewed

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "NextApp",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "Enter the name of the app (e.g: my-app)"
+    },
+    "directory": {
+      "type": "string",
+      "description": "",
+      "$default": {
+        "$source": "argv",
+        "index": 1
+      },
+      "x-prompt": "Enter the name of the directory in the 'apps/' folder (e.g: web)"
+    }
+  },
+  "required": ["name", "directory"]
+}