@domain-first/project-structure 8.11.0 → 8.13.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,115 @@ 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
+ },
498
+ svelte: {
499
+ prefix: 'create',
500
+ shared: [
501
+ 'shared',
502
+ 'model'
503
+ ]
504
+ }
505
+ };
506
+ const kindLayouts = (framework)=>{
507
+ const { component, hook } = frontendExtensions[framework];
508
+ const { prefix, shared } = frontendLogicNaming[framework];
509
+ return {
510
+ page: {
511
+ folder: 'pages',
512
+ nested: true,
513
+ inFolder: false,
514
+ ownFile: (fileBase)=>new RegExp(`^${module_move_escapeRegExp(fileBase)}-page(?:\\.|$)`),
515
+ target: (reactFolder, { folders, fileName })=>external_node_path_default().join(reactFolder, 'pages', ...folders, `${fileName}-page${component}`),
516
+ classPrefix: `(${prefix})?`,
517
+ classSuffix: 'Page'
518
+ },
519
+ widget: {
520
+ folder: 'widgets',
521
+ nested: true,
522
+ inFolder: true,
523
+ target: (reactFolder, { folders, folderName })=>external_node_path_default().join(reactFolder, 'widgets', ...folders, folderName),
524
+ classPrefix: `(${prefix})?`,
525
+ classSuffix: 'Widget|UIModel',
526
+ storyTitle: (segments)=>[
527
+ 'Widgets',
528
+ ...segments
529
+ ].join('/')
530
+ },
531
+ 'ui-kit': {
532
+ folder: 'ui-kit',
533
+ nested: false,
534
+ inFolder: true,
535
+ target: (reactFolder, { fileName })=>external_node_path_default().join(reactFolder, 'ui-kit', fileName),
536
+ classPrefix: '()',
537
+ classSuffix: 'Props(?![\\w$])|(?![\\w$])',
538
+ storyTitle: (segments)=>`UI-kit/${segments.join('')}`
539
+ },
540
+ hook: {
541
+ folder: shared.join('/'),
542
+ nested: false,
543
+ inFolder: false,
544
+ ownFile: (fileBase)=>new RegExp(`^${prefix}-${module_move_escapeRegExp(fileBase)}(?:\\.|$)`),
545
+ target: (reactFolder, { fileName })=>external_node_path_default().join(reactFolder, ...shared, `${prefix}-${fileName}${hook}`),
546
+ classPrefix: `(${prefix})`,
547
+ classSuffix: '(?![\\w$])'
548
+ }
549
+ };
550
+ };
551
+ kindLayouts('react');
552
+ kindLayouts('svelte');
553
+ const reactKindTitles = {
554
+ page: [
555
+ 'Page',
556
+ 'pages'
557
+ ],
558
+ widget: [
559
+ 'Widget',
560
+ 'widgets'
561
+ ],
562
+ 'ui-kit': [
563
+ 'UI-kit component',
564
+ 'UI-kit components'
565
+ ],
566
+ hook: [
567
+ 'Shared hook',
568
+ 'shared hooks'
569
+ ]
570
+ };
571
+ ({
572
+ ...reactKindTitles,
573
+ hook: [
574
+ 'Shared model',
575
+ 'shared models'
576
+ ]
577
+ });
469
578
  class UnknownFormatNaming {
470
579
  rawSource;
471
580
  camelCase;
@@ -738,7 +847,7 @@ const wiredDependencyNames = (source, className)=>{
738
847
  const { openIndex, closeIndex } = wireListRange(source, className);
739
848
  return splitTopLevel(source.slice(openIndex + 1, closeIndex));
740
849
  };
741
- const readAliases = (projectRoot)=>{
850
+ const project_lint_readAliases = (projectRoot)=>{
742
851
  const tsconfig = external_node_path_default().join(projectRoot, 'tsconfig.json');
743
852
  const paths = compilerOption(tsconfig, 'paths');
744
853
  if (!paths || 'object' != typeof paths) return [];
@@ -775,7 +884,7 @@ const sourceFiles = (folder)=>{
775
884
  };
776
885
  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
886
  const lineAt = (source, index)=>source.slice(0, index).split('\n').length;
778
- const importsOf = (source, file, aliases)=>[
887
+ const project_lint_importsOf = (source, file, aliases)=>[
779
888
  ...source.matchAll(importPattern)
780
889
  ].map((match)=>({
781
890
  typeOnly: 'import' === match[1] && Boolean(match[2]),
@@ -845,13 +954,14 @@ const importViolations = (projectRoot, rootFolder, rules)=>{
845
954
  folder,
846
955
  uiKit: external_node_path_default().join(folder, 'ui-kit'),
847
956
  widgets: external_node_path_default().join(folder, 'widgets'),
848
- hooks: external_node_path_default().join(folder, 'hooks'),
957
+ hooks: external_node_path_default().join(folder, ...frontendLogicNaming[framework].shared),
958
+ 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
959
  widgetFile: 'svelte' === framework ? '-widget.svelte' : '-widget.tsx'
850
960
  };
851
961
  });
852
962
  const frontendOf = (file)=>frontends.find((frontend)=>inside(frontend.folder, file));
853
963
  const inMemoryDbFile = external_node_path_default().join(sharedFolder, 'infrastructure', 'services', 'in-memory-db-infrastructure-service.ts');
854
- const aliases = readAliases(projectRoot);
964
+ const aliases = project_lint_readAliases(projectRoot);
855
965
  const violations = [];
856
966
  const contextOf = (file)=>{
857
967
  const segments = inside(contextsFolder, file);
@@ -913,7 +1023,7 @@ const importViolations = (projectRoot, rootFolder, rules)=>{
913
1023
  line: imported.line,
914
1024
  text: imported.statement
915
1025
  });
916
- for (const imported of importsOf(source, file, aliases)){
1026
+ for (const imported of project_lint_importsOf(source, file, aliases)){
917
1027
  const target = imported.target;
918
1028
  if (!target) continue;
919
1029
  const to = locate(target);
@@ -935,7 +1045,7 @@ const importViolations = (projectRoot, rootFolder, rules)=>{
935
1045
  'widgets',
936
1046
  'pages'
937
1047
  ];
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);
1048
+ if (targetContext || forbidden.includes(area)) report(frontend.check, inUiKit ? `[${frontend.label}/ui-kit] imports a bounded context, widget or page:` : frontend.hooksLabel, imported);
939
1049
  } 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
1050
  const ownWidget = widgetOf(file);
941
1051
  const targetWidget = widgetOf(target);
@@ -977,7 +1087,7 @@ const wiringViolations = (projectRoot, rootFolder, rules)=>{
977
1087
  module.wireFile,
978
1088
  module
979
1089
  ]));
980
- const aliases = readAliases(projectRoot);
1090
+ const aliases = project_lint_readAliases(projectRoot);
981
1091
  for (const { name, modules } of owners){
982
1092
  const visible = new Map([
983
1093
  ...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,17 @@ 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
+ }>;
15
26
  export type ReactModule = {
16
27
  kind: ReactModuleKind;
17
28
  /** Name, nested for pages and widgets, e.g. `admin/users`. */
@@ -40,12 +51,17 @@ type ReactKindLayout = {
40
51
  storyTitle?: (segments: string[]) => string;
41
52
  };
42
53
  export declare const reactKindLayouts: Record<ReactModuleKind, ReactKindLayout>;
54
+ /** Svelte: shared models in `shared/model/create-n.svelte.ts`. */
43
55
  export declare const svelteKindLayouts: Record<ReactModuleKind, ReactKindLayout>;
44
56
  export declare const frontendKindLayouts: (framework: FrontendFramework) => Record<ReactModuleKind, ReactKindLayout>;
45
57
  /** How menus name each kind, singular and plural. */
46
58
  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;
59
+ export declare const frontendKindTitles: (framework: FrontendFramework) => Record<ReactModuleKind, [string, string]>;
60
+ /**
61
+ * A shared hook's (model's) name is entered without `use-` (`create-`), as
62
+ * its generator takes it.
63
+ */
64
+ export declare const reactModuleName: (kind: ReactModuleKind, rawName: string, framework?: FrontendFramework) => string;
49
65
  export declare const findReactModules: (reactFolder: string, kind: ReactModuleKind, framework?: FrontendFramework) => ReactModule[];
50
66
  export declare const validateMove: (reactFolder: string, module: ReactModule, rawName: string, framework?: FrontendFramework) => string | true;
51
67
  /** A Next.js App Router or SvelteKit route folder moved with a page. */