@domain-first/project-structure 8.11.0 → 8.12.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.
package/dist/lint.cjs CHANGED
@@ -433,7 +433,7 @@ const context_dependencies_crossContextImportAllowed = (from, to)=>{
433
433
  ].includes(targetKind) && (isCrossContextImplementation(from) && 'application' === targetLayer || 'wiring' === layer && 'application-ports' === kind && 'wiring' === targetLayer);
434
434
  };
435
435
  const external_node_module_namespaceObject = require("node:module");
436
- const stripJsonComments = (source)=>source.replace(/("(?:\\.|[^"\\])*")|\/\/[^\n]*|\/\*[\s\S]*?\*\//g, (_, text)=>text ? text : '').replace(/,(\s*[}\]])/g, '$1');
436
+ const tsconfig_stripJsonComments = (source)=>source.replace(/("(?:\\.|[^"\\])*")|\/\/[^\n]*|\/\*[\s\S]*?\*\//g, (_, text)=>text ? text : '').replace(/,(\s*[}\]])/g, '$1');
437
437
  const resolveExtends = (fromFile, target)=>{
438
438
  if (target.startsWith('.') || external_node_path_default().isAbsolute(target)) {
439
439
  const resolved = external_node_path_default().resolve(external_node_path_default().dirname(fromFile), target);
@@ -452,7 +452,7 @@ const compilerOption = (configFile, name, seen = new Set())=>{
452
452
  seen.add(configFile);
453
453
  let config;
454
454
  try {
455
- config = JSON.parse(stripJsonComments(external_node_fs_default().readFileSync(configFile, 'utf8')));
455
+ config = JSON.parse(tsconfig_stripJsonComments(external_node_fs_default().readFileSync(configFile, 'utf8')));
456
456
  } catch {
457
457
  return null;
458
458
  }
@@ -466,6 +466,117 @@ const compilerOption = (configFile, name, seen = new Set())=>{
466
466
  if (void 0 !== value) return value;
467
467
  }
468
468
  };
469
+ new Set([
470
+ 'node_modules',
471
+ '.git',
472
+ '.next',
473
+ '.svelte-kit',
474
+ 'dist',
475
+ 'build',
476
+ 'out',
477
+ 'coverage',
478
+ 'storybook-static'
479
+ ]);
480
+ const module_move_escapeRegExp = (value)=>value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
481
+ const frontendExtensions = {
482
+ react: {
483
+ component: '.tsx',
484
+ hook: '.ts'
485
+ },
486
+ svelte: {
487
+ component: '.svelte',
488
+ hook: '.svelte.ts'
489
+ }
490
+ };
491
+ const frontendLogicNaming = {
492
+ react: {
493
+ prefix: 'use',
494
+ shared: [
495
+ 'hooks'
496
+ ],
497
+ widgetModel: 'hooks'
498
+ },
499
+ svelte: {
500
+ prefix: 'create',
501
+ shared: [
502
+ 'shared',
503
+ 'model'
504
+ ],
505
+ widgetModel: 'model'
506
+ }
507
+ };
508
+ const kindLayouts = (framework)=>{
509
+ const { component, hook } = frontendExtensions[framework];
510
+ const { prefix, shared } = frontendLogicNaming[framework];
511
+ return {
512
+ page: {
513
+ folder: 'pages',
514
+ nested: true,
515
+ inFolder: false,
516
+ ownFile: (fileBase)=>new RegExp(`^${module_move_escapeRegExp(fileBase)}-page(?:\\.|$)`),
517
+ target: (reactFolder, { folders, fileName })=>external_node_path_default().join(reactFolder, 'pages', ...folders, `${fileName}-page${component}`),
518
+ classPrefix: `(${prefix})?`,
519
+ classSuffix: 'Page'
520
+ },
521
+ widget: {
522
+ folder: 'widgets',
523
+ nested: true,
524
+ inFolder: true,
525
+ target: (reactFolder, { folders, folderName })=>external_node_path_default().join(reactFolder, 'widgets', ...folders, folderName),
526
+ classPrefix: `(${prefix})?`,
527
+ classSuffix: 'Widget|UIModel',
528
+ storyTitle: (segments)=>[
529
+ 'Widgets',
530
+ ...segments
531
+ ].join('/')
532
+ },
533
+ 'ui-kit': {
534
+ folder: 'ui-kit',
535
+ nested: false,
536
+ inFolder: true,
537
+ target: (reactFolder, { fileName })=>external_node_path_default().join(reactFolder, 'ui-kit', fileName),
538
+ classPrefix: '()',
539
+ classSuffix: 'Props(?![\\w$])|(?![\\w$])',
540
+ storyTitle: (segments)=>`UI-kit/${segments.join('')}`
541
+ },
542
+ hook: {
543
+ folder: shared.join('/'),
544
+ nested: false,
545
+ inFolder: false,
546
+ ownFile: (fileBase)=>new RegExp(`^${prefix}-${module_move_escapeRegExp(fileBase)}(?:\\.|$)`),
547
+ target: (reactFolder, { fileName })=>external_node_path_default().join(reactFolder, ...shared, `${prefix}-${fileName}${hook}`),
548
+ classPrefix: `(${prefix})`,
549
+ classSuffix: '(?![\\w$])'
550
+ }
551
+ };
552
+ };
553
+ kindLayouts('react');
554
+ kindLayouts('svelte');
555
+ const reactKindTitles = {
556
+ page: [
557
+ 'Page',
558
+ 'pages'
559
+ ],
560
+ widget: [
561
+ 'Widget',
562
+ 'widgets'
563
+ ],
564
+ 'ui-kit': [
565
+ 'UI-kit component',
566
+ 'UI-kit components'
567
+ ],
568
+ hook: [
569
+ 'Shared hook',
570
+ 'shared hooks'
571
+ ]
572
+ };
573
+ ({
574
+ ...reactKindTitles,
575
+ hook: [
576
+ 'Shared model',
577
+ 'shared models'
578
+ ]
579
+ });
469
580
  class UnknownFormatNaming {
470
581
  rawSource;
471
582
  camelCase;
@@ -738,7 +849,7 @@ const wiredDependencyNames = (source, className)=>{
738
849
  const { openIndex, closeIndex } = wireListRange(source, className);
739
850
  return splitTopLevel(source.slice(openIndex + 1, closeIndex));
740
851
  };
741
- const readAliases = (projectRoot)=>{
852
+ const project_lint_readAliases = (projectRoot)=>{
742
853
  const tsconfig = external_node_path_default().join(projectRoot, 'tsconfig.json');
743
854
  const paths = compilerOption(tsconfig, 'paths');
744
855
  if (!paths || 'object' != typeof paths) return [];
@@ -775,7 +886,7 @@ const sourceFiles = (folder)=>{
775
886
  };
776
887
  const importPattern = /\b(?:(import|export)\s+(type\s+)?(?:(?!\b(?:import|export)\b)[\w*{}\s,$])*?\s*from\s*|import\s*\(\s*|require\s*\(\s*|import\s*)(['"])([^'"\n]+)\3/g;
777
888
  const lineAt = (source, index)=>source.slice(0, index).split('\n').length;
778
- const importsOf = (source, file, aliases)=>[
889
+ const project_lint_importsOf = (source, file, aliases)=>[
779
890
  ...source.matchAll(importPattern)
780
891
  ].map((match)=>({
781
892
  typeOnly: 'import' === match[1] && Boolean(match[2]),
@@ -845,13 +956,14 @@ const importViolations = (projectRoot, rootFolder, rules)=>{
845
956
  folder,
846
957
  uiKit: external_node_path_default().join(folder, 'ui-kit'),
847
958
  widgets: external_node_path_default().join(folder, 'widgets'),
848
- hooks: external_node_path_default().join(folder, 'hooks'),
959
+ hooks: external_node_path_default().join(folder, ...frontendLogicNaming[framework].shared),
960
+ hooksLabel: 'svelte' === framework ? "[presentation/svelte/shared/model] a shared model imports a bounded context, UI-kit, widget or page:" : "[presentation/react/hooks] a shared hook imports a bounded context, UI-kit, widget or page:",
849
961
  widgetFile: 'svelte' === framework ? '-widget.svelte' : '-widget.tsx'
850
962
  };
851
963
  });
852
964
  const frontendOf = (file)=>frontends.find((frontend)=>inside(frontend.folder, file));
853
965
  const inMemoryDbFile = external_node_path_default().join(sharedFolder, 'infrastructure', 'services', 'in-memory-db-infrastructure-service.ts');
854
- const aliases = readAliases(projectRoot);
966
+ const aliases = project_lint_readAliases(projectRoot);
855
967
  const violations = [];
856
968
  const contextOf = (file)=>{
857
969
  const segments = inside(contextsFolder, file);
@@ -913,7 +1025,7 @@ const importViolations = (projectRoot, rootFolder, rules)=>{
913
1025
  line: imported.line,
914
1026
  text: imported.statement
915
1027
  });
916
- for (const imported of importsOf(source, file, aliases)){
1028
+ for (const imported of project_lint_importsOf(source, file, aliases)){
917
1029
  const target = imported.target;
918
1030
  if (!target) continue;
919
1031
  const to = locate(target);
@@ -935,7 +1047,7 @@ const importViolations = (projectRoot, rootFolder, rules)=>{
935
1047
  'widgets',
936
1048
  'pages'
937
1049
  ];
938
- if (targetContext || forbidden.includes(area)) report(frontend.check, inUiKit ? `[${frontend.label}/ui-kit] imports a bounded context, widget or page:` : `[${frontend.label}/hooks] a shared hook imports a bounded context, UI-kit, widget or page:`, imported);
1050
+ if (targetContext || forbidden.includes(area)) report(frontend.check, inUiKit ? `[${frontend.label}/ui-kit] imports a bounded context, widget or page:` : frontend.hooksLabel, imported);
939
1051
  } else if (frontend && targetContext && !(imported.typeOnly && to?.segments[0] === 'presentation' && 'rest' === to.segments[1])) report(frontend.check, `[${frontend.label}] imports a context other than \`import type\` from presentation/rest:`, imported);
940
1052
  const ownWidget = widgetOf(file);
941
1053
  const targetWidget = widgetOf(target);
@@ -977,7 +1089,7 @@ const wiringViolations = (projectRoot, rootFolder, rules)=>{
977
1089
  module.wireFile,
978
1090
  module
979
1091
  ]));
980
- const aliases = readAliases(projectRoot);
1092
+ const aliases = project_lint_readAliases(projectRoot);
981
1093
  for (const { name, modules } of owners){
982
1094
  const visible = new Map([
983
1095
  ...sharedModules,
package/dist/lint.js CHANGED
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  import { parseArgs } from "node:util";
3
- import { configuredDependencyRules, ProjectRoot, outdatedConfigMessage, ConfigFile } from "./201.js";
3
+ import { configuredDependencyRules, ProjectRoot, outdatedConfigMessage, ConfigFile } from "./878.js";
4
4
  import { lintProject, formatViolations } from "./38.js";
5
5
  const help = `Usage: df-lint [rootFolder]
6
6
 
@@ -12,6 +12,19 @@ export declare const frontendExtensions: Record<FrontendFramework, {
12
12
  component: string;
13
13
  hook: string;
14
14
  }>;
15
+ /**
16
+ * Naming of reusable logic: React hooks (`hooks/use-n.ts`, `useN`) and
17
+ * Svelte 5 models (`shared/model/create-n.svelte.ts`, `createN`). In
18
+ * SvelteKit "hooks" are `hooks.server.ts`, so Svelte has no hooks.
19
+ */
20
+ export declare const frontendLogicNaming: Record<FrontendFramework, {
21
+ /** Function name prefix: `useN`, `createN`. */
22
+ prefix: 'use' | 'create';
23
+ /** Folder of shared hooks (models), under `presentation/<framework>`. */
24
+ shared: string[];
25
+ /** Folder of a widget's UI model, inside the widget. */
26
+ widgetModel: string;
27
+ }>;
15
28
  export type ReactModule = {
16
29
  kind: ReactModuleKind;
17
30
  /** Name, nested for pages and widgets, e.g. `admin/users`. */
@@ -40,12 +53,17 @@ type ReactKindLayout = {
40
53
  storyTitle?: (segments: string[]) => string;
41
54
  };
42
55
  export declare const reactKindLayouts: Record<ReactModuleKind, ReactKindLayout>;
56
+ /** Svelte: shared models in `shared/model/create-n.svelte.ts`. */
43
57
  export declare const svelteKindLayouts: Record<ReactModuleKind, ReactKindLayout>;
44
58
  export declare const frontendKindLayouts: (framework: FrontendFramework) => Record<ReactModuleKind, ReactKindLayout>;
45
59
  /** How menus name each kind, singular and plural. */
46
60
  export declare const reactKindTitles: Record<ReactModuleKind, [string, string]>;
47
- /** A hook's name is entered without `use-`, as its generator takes it. */
48
- export declare const reactModuleName: (kind: ReactModuleKind, rawName: string) => string;
61
+ export declare const frontendKindTitles: (framework: FrontendFramework) => Record<ReactModuleKind, [string, string]>;
62
+ /**
63
+ * A shared hook's (model's) name is entered without `use-` (`create-`), as
64
+ * its generator takes it.
65
+ */
66
+ export declare const reactModuleName: (kind: ReactModuleKind, rawName: string, framework?: FrontendFramework) => string;
49
67
  export declare const findReactModules: (reactFolder: string, kind: ReactModuleKind, framework?: FrontendFramework) => ReactModule[];
50
68
  export declare const validateMove: (reactFolder: string, module: ReactModule, rawName: string, framework?: FrontendFramework) => string | true;
51
69
  /** A Next.js App Router or SvelteKit route folder moved with a page. */