xenopomp-essentials 0.3.1 → 0.3.2

package/.config/.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "**/*.{js,ts,jsx,tsx}": "yarn lint:code"
+}

package/.config/build.config.ts

@@ -0,0 +1,41 @@
+import { copyFile } from 'node:fs/promises';
+import path from 'node:path';
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig([
+  {
+    entries: [
+      // Main entry
+      './src/index.ts',
+
+      // Type declarations
+      {
+        builder: 'mkdist',
+        input: './src/declarations',
+        outDir: './dist/declarations',
+      },
+
+      // Modules that are not to be exported from main module
+      './src/next/index.ts',
+      './src/cli-tools/index.ts',
+      './src/eslint/index.ts',
+    ],
+    outDir: './dist',
+    failOnWarn: false,
+    declaration: true,
+    alias: {
+      '@': path.resolve(__dirname, '../', './src'),
+      '@test': path.resolve(__dirname, '../', './__tests__'),
+    },
+    rollup: {
+      esbuild: {
+        minify: true,
+      },
+    },
+    hooks: {
+      'build:done': async () => {
+        await copyFile('./package.json', './dist/package.json');
+      },
+    },
+  },
+]);

package/.config/testing-exclusions/index.ts

@@ -0,0 +1,2 @@
+export * from './vitest-exclusions';
+export * from './istanbul-exclusions';

package/.config/testing-exclusions/istanbul-exclusions.ts

@@ -0,0 +1 @@
+export const istanbulExclusions: string[] = [];

package/.config/testing-exclusions/vitest-exclusions.ts

@@ -0,0 +1,8 @@
+import { configDefaults } from 'vitest/config';
+
+export const vitestExclusions: string[] = [
+  ...configDefaults.exclude,
+  '.config',
+  '__tests__/{assets,data}',
+  '__tests__/**/*.test-source.*',
+];

package/.config/ts/tsconfig.lint.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "../../**/*.ts",
+    "../../**/*.tsx",
+    "../../**/.config/**/*.ts",
+    "../../**/__tests__/**/*.ts",
+  ],
+  "exclude": ["node_modules"]
+}

package/.config/vitest.config.ts

@@ -0,0 +1,18 @@
+import react from '@vitejs/plugin-react';
+import tsconfigPathsPlugin from 'vite-tsconfig-paths';
+import { defineConfig } from 'vitest/config';
+
+import { istanbulExclusions, vitestExclusions } from './testing-exclusions';
+
+export default defineConfig({
+  plugins: [react(), tsconfigPathsPlugin()],
+  test: {
+    environment: 'jsdom',
+    exclude: vitestExclusions,
+    coverage: {
+      provider: 'istanbul',
+      reporter: ['text', 'json', 'json-summary', 'html'],
+      exclude: [...vitestExclusions, ...istanbulExclusions],
+    },
+  },
+});

package/.gitattributes

@@ -0,0 +1,25 @@
+# Auto detect text files and perform LF normalization
+* text eol=lf
+
+.nvmrc text
+
+# Binary files should be encoded as binary
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.mov binary
+*.mp4 binary
+*.mp3 binary
+*.flv binary
+*.fla binary
+*.swf binary
+*.gz binary
+*.zip binary
+*.7z binary
+*.ttf binary
+*.eot binary
+*.woff binary
+*.pyc binary
+*.pdf binary

package/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: 'CI'
+on:
+  push:
+    branches:
+      - main
+      - master
+
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  # Install Node.js and dependencies
+  ci:
+    strategy:
+      matrix:
+        NODE_VERSION:
+          - '20'
+          - '22'
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: mstachniuk/ci-skip@v1
+        with:
+          commit-filter: '[skip ci]'
+
+      - uses: actions/checkout@v4
+
+      - name: '🧩 Install Node (${{ matrix.NODE_VERSION }})'
+        uses: actions/setup-node@v4
+        with:
+          node-version: '${{ matrix.NODE_VERSION }}'
+
+      - name: '📦 Install dependencies'
+        run: yarn install --frozen-lockfile
+
+      - name: '📕 Linting'
+        run: yarn lint
+
+      # Start to run our inline jobs
+      # Vitest
+      - name: '🧪 Run coverage'
+        run: yarn coverage
+
+      - name: '✍️ Report coverage'
+        if: always() # Also generate the report if tests are failing
+        uses: davelosert/vitest-coverage-report-action@v2
+        with:
+          vite-config-path: .config/vitest.config.ts

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,27 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    name: Publish to NPM registry
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build all sources
+        run: |
+          yarn install --frozen-lockfile
+          yarn build
+
+      - name: Publish if version has been updated
+        uses: JS-DevTools/npm-publish@v2
+        with:
+          token: ${{ secrets.npm_token }}
+          access: public
+          package: ./dist/package.json

package/.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged -c ./.config/.lintstagedrc.json

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,59 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
+    </HTMLCodeStyleSettings>
+    <JSCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="USE_DOUBLE_QUOTES" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="Remove" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="USE_DOUBLE_QUOTES" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="Remove" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </TypeScriptCodeStyleSettings>
+    <VueCodeStyleSettings>
+      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
+      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
+    </VueCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="Vue">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/xenopomp-essentials-js.iml" filepath="$PROJECT_DIR$/.idea/xenopomp-essentials-js.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/prettier.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+    <option name="myRunOnSave" value="true" />
+  </component>
+</project>

package/.idea/runConfigurations/_template__of_Vitest.xml

@@ -0,0 +1,9 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="true" type="JavaScriptTestRunnerVitest">
+    <node-interpreter value="project" />
+    <vitest-options value="-c ./.config/vitest.config.ts" />
+    <envs />
+    <scope-kind value="ALL" />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/build.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="build" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="build" />
+    </scripts>
+    <node-interpreter value="project" />
+    <package-manager value="yarn" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/coverage.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="coverage" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="coverage" />
+    </scripts>
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/lint.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="lint" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="lint" />
+    </scripts>
+    <node-interpreter value="project" />
+    <package-manager value="yarn" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/lint_code.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="lint:code" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="lint:code" />
+    </scripts>
+    <node-interpreter value="project" />
+    <package-manager value="yarn" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.idea/xenopomp-essentials-js.iml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/__tests__" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/.yarn" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.prettierrc

@@ -0,0 +1,20 @@
+{
+  "parser": "typescript",
+  "tabWidth": 2,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "semi": true,
+  "useTabs": false,
+  "arrowParens": "avoid",
+  "singleAttributePerLine": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "importOrder": [
+    "<THIRD_PARTY_MODULES>",
+    "^@/(.*)$",
+    "^@test/(.*)$",
+    "^../(.*)$",
+    "^./(.*)$"
+  ],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
+}

package/__tests__/assets/assertions/expect-deep-equal.ts

@@ -0,0 +1,14 @@
+import { expect } from 'vitest';
+
+/**
+ * Deeply checks if two objects are equal.
+ *
+ * @param expected
+ * @param real
+ */
+export const expectToDeepEqual = <Type>(
+  expected: Type,
+  real: NoInfer<Type>,
+) => {
+  expect(expected).to.deep.equal(real);
+};

package/__tests__/assets/assertions/expect-to-render.ts

@@ -0,0 +1,26 @@
+import { render, renderHook } from '@testing-library/react';
+
+import { assertNotThrowing } from '@test/assets';
+
+type RenderArguments = Parameters<typeof render>;
+type RenderHookArguments = Parameters<typeof renderHook>;
+
+type RenderFunc<Args extends unknown[] = RenderArguments> = (
+  ...args: Args
+) => void;
+
+/** Renders component and expects that it won't throw error. */
+export const expectToRender: RenderFunc = (...props) => {
+  assertNotThrowing(() => render(...props));
+};
+
+/**
+ * Renders hook within test React component without having to create that component yourself.
+ * Expects that it won't throw error.
+ * @param props
+ */
+export const expectHookToRender: RenderFunc<RenderHookArguments> = (
+  ...props
+) => {
+  assertNotThrowing(() => renderHook(...props));
+};

package/__tests__/assets/assertions/index.ts

@@ -0,0 +1,3 @@
+export * from './not-throwing';
+export * from './expect-deep-equal';
+export * from './expect-to-render';

package/__tests__/assets/assertions/not-throwing.ts

@@ -0,0 +1,6 @@
+import { expect } from 'vitest';
+
+/** Executes function and expects that it won't throw. */
+export const assertNotThrowing = (callable: () => void) => {
+  expect(() => callable()).not.toThrow();
+};

package/__tests__/assets/index.ts

@@ -0,0 +1 @@
+export * from './assertions';

package/__tests__/data/index.ts

@@ -0,0 +1 @@
+export * from './parseVersion.data';

package/__tests__/data/parseVersion.data.ts

@@ -0,0 +1,52 @@
+import type { VersionData } from '@/utils';
+
+export const testCases: Array<VersionData & { input: string }> = [
+  {
+    input: 'Random string',
+    version: null,
+    preid: undefined,
+    prerelease: undefined,
+  },
+  {
+    input: '0.0.0',
+    version: '0.0.0',
+    prerelease: undefined,
+    preid: undefined,
+  },
+  {
+    input: '0.0.0-alpha.0',
+    version: '0.0.0',
+    preid: 'alpha',
+    prerelease: '0',
+  },
+  {
+    input: '0.0.0-beta.0',
+    version: '0.0.0',
+    preid: 'beta',
+    prerelease: '0',
+  },
+  {
+    input: '0.0.0-rc.0',
+    version: '0.0.0',
+    preid: 'rc',
+    prerelease: '0',
+  },
+  {
+    input: '0.0.0-rc.1',
+    version: '0.0.0',
+    preid: 'rc',
+    prerelease: '1',
+  },
+  {
+    input: '0.0.0-rc.25',
+    version: '0.0.0',
+    preid: 'rc',
+    prerelease: '25',
+  },
+  {
+    input: '0.0.0-canary.0',
+    version: '0.0.0',
+    preid: 'canary',
+    prerelease: '0',
+  },
+];

package/__tests__/unit/cli/path-builder.test.ts

@@ -0,0 +1,39 @@
+import { readFile } from 'node:fs/promises';
+import path from 'node:path';
+import type { PackageJson } from 'type-fest';
+import { afterEach, describe, expect, test } from 'vitest';
+
+import { PathBuilder } from '@/cli-tools';
+
+const findPackageJson = async (res: string) => {
+  const packageJsonText = await readFile(path.join(res, 'package.json'), {
+    encoding: 'utf-8',
+  });
+  const packageJson = JSON.parse(packageJsonText) as PackageJson;
+
+  expect(packageJson.name).toBe('xenopomp-essentials');
+};
+
+describe('PathBuilder class', () => {
+  const builder = new PathBuilder();
+
+  afterEach(() => builder.clear());
+
+  test('cwd method works', async () => {
+    await findPackageJson(builder.cwd().build());
+  });
+
+  test('appSource method works', async () => {
+    await findPackageJson(builder.appSource().build());
+  });
+
+  test('cd method works', async () => {
+    const res = builder.cd('./src').cd('../').build();
+    await findPackageJson(res);
+  });
+
+  test('file method works', () => {
+    const res = builder.cd('./src').cd('../').file('.prettierrc').build();
+    expect(res.endsWith('.prettierrc')).toBe(true);
+  });
+});

package/__tests__/unit/components/hoc/jsx-dot-notation/component.test-source.tsx

@@ -0,0 +1,24 @@
+import type { FC, PropsWithChildren } from 'react';
+
+import { jsxDotNotation } from '@/react';
+
+const FlexComp: FC<PropsWithChildren> = ({ children }) => <div>{children}</div>;
+const FlexRow: FC<PropsWithChildren & { short?: boolean }> = ({ children }) => (
+  <div>{children}</div>
+);
+const FlexCol: FC<PropsWithChildren> = ({ children }) => <div>{children}</div>;
+
+export const Flex = jsxDotNotation(FlexComp, {
+  Row: FlexRow,
+  Col: FlexCol,
+});
+
+export const Am = () => {
+  return (
+    <Flex>
+      <Flex.Row short>
+        <Flex.Col></Flex.Col>
+      </Flex.Row>
+    </Flex>
+  );
+};

package/__tests__/unit/components/hoc/jsx-dot-notation/hoc.test.tsx

@@ -0,0 +1,11 @@
+import { describe, test } from 'vitest';
+
+import { expectToRender } from '@test/assets';
+
+import { Am } from './component.test-source';
+
+describe('jsxDotNotation HOC', () => {
+  test('It renders', () => {
+    expectToRender(<Am />);
+  });
+});

package/__tests__/unit/components/metrika.test.tsx

@@ -0,0 +1,14 @@
+import { cleanup } from '@testing-library/react';
+import { afterAll, describe, test } from 'vitest';
+
+import { Metrika } from '@/next';
+
+import { expectToRender } from '@test/assets';
+
+describe('Yandex.Metrika script component', () => {
+  test('It renders', () => {
+    afterAll(() => cleanup());
+
+    expectToRender(<Metrika id={-1} />);
+  });
+});

package/__tests__/unit/components/react-scan.test.tsx

@@ -0,0 +1,10 @@
+import React from 'react';
+import { describe, test } from 'vitest';
+
+import { ReactScan } from '@/next';
+
+import { expectToRender } from '@test/assets';
+
+describe('react-scan script', () => {
+  test('It renders', () => expectToRender(<ReactScan />));
+});