chore: store source files in src/

.github/workflows/translations-pr-lint.yml

@@ -13,8 +13,8 @@ on:
       - 'apps/site/pages/**/*.mdx'
       - '!apps/site/pages/en/**/*.md'
       - '!apps/site/pages/en/**/*.mdx'
-      - 'packages/i18n/locales/*.json'
-      - '!packages/i18n/locales/en.json'
+      - 'packages/i18n/src/locales/*.json'
+      - '!packages/i18n/src/locales/en.json'
       - 'apps/site/snippets/**/*.bash'
       - '!apps/site/snippets/en/**/*.bash'
 

.gitignore

@@ -43,3 +43,6 @@ apps/site/.wrangler
 ## Playwright
 test-results
 playwright-report
+
+## MacOS Ignored Files
+.DS_Store

crowdin.yml

@@ -42,8 +42,8 @@ files:
         pt-BR: pt-br
         zh-CN: zh-cn
         zh-TW: zh-tw
-  - source: /packages/i18n/locales/en.json
-    translation: /packages/i18n/locales/%two_letters_code%.json
+  - source: /packages/i18n/src/locales/en.json
+    translation: /packages/i18n/src/locales/%two_letters_code%.json
     languages_mapping:
       two_letters_code:
         es-ES: es

docs/adding-pages.md

@@ -117,7 +117,7 @@ Add your new article to `app/site/navigation.json`:
 Create translation keys for your navigation entries in the appropriate locale files:
 
 ```json
-// packages/i18n/locales/en.json
+// packages/i18n/src/locales/en.json
 {
   "components": {
     "navigation": {

docs/creating-components.md

@@ -40,7 +40,7 @@ The website uses a dual-package architecture for React components:
 Generic UI components should be placed in `@node-core/ui-components`:
 
 ```tsx
-// @node-core/ui-components/Common/Button/index.tsx
+// @node-core/ui-components/src/Common/Button/index.tsx
 import type { FC, ButtonHTMLAttributes } from 'react';
 import styles from './index.module.css';
 

docs/downloads-page.md

@@ -133,7 +133,7 @@ The snippet has access to a `props` variable of type `ReleaseContextType`:
 
 ### 5. Add Translation Key
 
-Add descriptive text in `packages/i18n/locales/en.json`:
+Add descriptive text in `packages/i18n/src/locales/en.json`:
 
 ```json
 {

packages/i18n/package.json

@@ -2,23 +2,16 @@
   "name": "@node-core/website-i18n",
   "type": "module",
   "exports": {
-    ".": "./lib/index.mjs",
-    "./config.json": "./config.json",
-    "./locales/*.json": "./locales/*.json",
-    "./types": {
-      "types": "./types.d.ts",
-      "default": "./types.d.ts"
-    }
+    "./*": [
+      "./src/*",
+      "./src/*.d.ts",
+      "./src/*.mjs",
+      "./src/*.json"
+    ],
+    ".": "./src/index.mjs"
   },
-  "main": "./lib/index.mjs",
-  "module": "./lib/index.mjs",
-  "types": "./dist/index.d.mts",
-  "files": [
-    "config.json",
-    "index.js",
-    "locales",
-    "types.d.ts"
-  ],
+  "main": "./src/index.mjs",
+  "module": "./src/index.mjs",
   "scripts": {
     "lint": "turbo lint:js",
     "lint:js": "eslint \"**/*.{js,mjs,ts}\"",

packages/i18n/lib/index.mjs → packages/i18n/src/index.mjs

@@ -1,15 +1,15 @@
 'use strict';
 
-import localeConfig from '../config.json' with { type: 'json' };
+import localeConfig from './config.json' with { type: 'json' };
 
 /**
  * Imports a locale when exists from the locales directory
  *
  * @param {string} locale The locale code to import
- * @returns {Promise<import('../types').Locale>} The imported locale
+ * @returns {Promise<import('./types').Locale>} The imported locale
  */
 export const importLocale = async locale => {
-  return import(`../locales/${locale}.json`, { with: { type: 'json' } }).then(
+  return import(`./locales/${locale}.json`, { with: { type: 'json' } }).then(
     f => f.default
   );
 };
@@ -19,7 +19,7 @@ export const importLocale = async locale => {
  * This is used for allowing us to redirect the user to any
  * of the available locales that we have enabled on the website
  *
- * @returns {Array<import('../types').LocaleConfig>}
+ * @returns {Array<import('./types').LocaleConfig>}
  */
 export const getAvailableLocales = () =>
   localeConfig.filter(locale => locale.enabled);

packages/i18n/tsconfig.json

@@ -16,6 +16,5 @@
     "outDir": "dist",
     "rootDir": "."
   },
-  "include": ["lib", "types.d.ts"],
-  "exclude": ["node_modules", "dist"]
+  "include": ["src"]
 }

packages/i18n/turbo.json

@@ -3,7 +3,7 @@
   "extends": ["//"],
   "tasks": {
     "lint:js": {
-      "inputs": ["lib/**/*.{js,mjs,ts}"]
+      "inputs": ["src/**/*.{js,mjs,ts}"]
     },
     "lint:fix": {
       "cache": false

packages/ui-components/.storybook/preview.tsx

@@ -4,7 +4,7 @@ import type { Preview, ReactRenderer } from '@storybook/react';
 
 import { STORYBOOK_MODES, STORYBOOK_SIZES } from './constants';
 
-import '../styles/index.css';
+import '#ui/styles/index.css';
 
 const preview: Preview = {
   parameters: {

packages/ui-components/.stylelintrc.mjs

@@ -26,7 +26,7 @@ export default {
   plugins: [
     'stylelint-order',
     'stylelint-selector-bem-pattern',
-    './stylelint/one-utility-class-per-line.mjs',
+    '#ui/stylelint/one-utility-class-per-line.mjs',
   ],
   rules: {
     // Enforces Element Class Names to be camelCase

packages/ui-components/package.json

@@ -3,22 +3,13 @@
   "type": "module",
   "exports": {
     "./*": [
-      "./*",
-      "./*.tsx",
-      "./*/index.tsx",
-      "./*.ts",
-      "./*/index.ts"
+      "./src/*",
+      "./src/*.tsx",
+      "./src/*/index.tsx",
+      "./src/*.ts",
+      "./src/*/index.ts"
     ]
   },
-  "files": [
-    "Common",
-    "Containers",
-    "Icons",
-    "MDX",
-    "stylelint",
-    "styles",
-    "types.ts"
-  ],
   "scripts": {
     "lint": "turbo run lint:js lint:css",
     "lint:css": "stylelint \"**/*.css\" --allow-empty-input --cache --cache-strategy=content --cache-location=.stylelintcache",
@@ -76,11 +67,11 @@
   },
   "imports": {
     "#ui/*": [
-      "./*",
-      "./*.tsx",
-      "./*/index.tsx",
-      "./*.ts",
-      "./*/index.ts"
+      "./src/*",
+      "./src/*.tsx",
+      "./src/*/index.tsx",
+      "./src/*.ts",
+      "./src/*/index.ts"
     ]
   },
   "engines": {

packages/ui-components/Common/BasePagination/PaginationListItem/__tests__/index.test.jsx → packages/ui-components/src/Common/BasePagination/PaginationListItem/__tests__/index.test.jsx

@@ -3,7 +3,7 @@ import assert from 'node:assert/strict';
 
 import { render, screen } from '@testing-library/react';
 
-import { isVisible } from '../../../../../../tests/utilities.mjs';
+import { isVisible } from '../../../../../../../tests/utilities.mjs';
 
 import PaginationListItem from '#ui/Common/BasePagination/PaginationListItem';
 

packages/ui-components/Common/BasePagination/__tests__/index.test.jsx → packages/ui-components/src/Common/BasePagination/__tests__/index.test.jsx

@@ -3,7 +3,7 @@ import assert from 'node:assert/strict';
 
 import { render, screen } from '@testing-library/react';
 
-import { isVisible } from '../../../../../tests/utilities.mjs';
+import { isVisible } from '../../../../../../tests/utilities.mjs';
 
 import BasePagination from '#ui/Common/BasePagination';
 

packages/ui-components/tsconfig.json

@@ -16,11 +16,5 @@
     "incremental": true,
     "baseUrl": "."
   },
-  "include": [
-    "**/*.ts",
-    "**/*.tsx",
-    ".storybook/**/*.ts",
-    ".storybook/**/*.tsx"
-  ],
-  "exclude": ["node_modules"]
+  "include": ["src"]
 }