@conarti/eslint-plugin-feature-sliced 1.0.5 → 2.0.0-rc.1

package/dist/index.d.cts

@@ -0,0 +1,63 @@
+import { Linter } from 'eslint';
+
+type TypedFlatConfigItem = Omit<Linter.Config<Linter.RulesRecord>, 'plugins'> & {
+    /**
+     * An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
+     *
+     * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
+     */
+    plugins?: Record<string, any>;
+};
+type ImportOrderConfigName = 'recommended' | 'with-newlines' | 'with-newlines-and-type-group' | 'with-type-group';
+
+declare const enum VALIDATION_LEVEL {
+    SEGMENTS = "segments",
+    SLICES = "slices"
+}
+
+interface AbsoluteRelativeOptions {
+    /**
+     * Disable the rule in certain files
+     */
+    ignoreInFilesPatterns: string[];
+}
+interface LayersSlicesOptions {
+    /**
+     * Ignore cross-imports of types
+     * @default true
+     */
+    allowTypeImports: boolean;
+    /**
+     * Ignore certain import paths (import foo from '<path-to-ignore>')
+     */
+    ignorePatterns: string[];
+    /**
+     * Disable the rule in certain files
+     */
+    ignoreInFilesPatterns: string[];
+}
+interface PublicApiOptions {
+    /**
+     * Adjusts the depth.
+     * 'slices' will check for presence 'index' file at the slice level only,
+     * 'segments' at the slice and its segments level
+     * Default is 'slices', but 'segments' is recommended
+     * @default 'slices'
+     */
+    level: VALIDATION_LEVEL;
+    /**
+     * Disable the rule in certain files
+     */
+    ignoreInFilesPatterns: string[];
+}
+interface ESLintPluginFeatureSlicedRuleOptions {
+    absoluteRelative?: false | AbsoluteRelativeOptions;
+    layersSlices?: false | LayersSlicesOptions;
+    publicApi?: false | PublicApiOptions;
+}
+interface ESLintPluginFeatureSlicedOptions extends ESLintPluginFeatureSlicedRuleOptions {
+    sortImports?: false | ImportOrderConfigName;
+}
+declare function createPlugin(options?: ESLintPluginFeatureSlicedOptions): TypedFlatConfigItem;
+
+export { createPlugin as default };

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { Linter } from 'eslint';
+
+type TypedFlatConfigItem = Omit<Linter.Config<Linter.RulesRecord>, 'plugins'> & {
+    /**
+     * An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
+     *
+     * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
+     */
+    plugins?: Record<string, any>;
+};
+type ImportOrderConfigName = 'recommended' | 'with-newlines' | 'with-newlines-and-type-group' | 'with-type-group';
+
+declare const enum VALIDATION_LEVEL {
+    SEGMENTS = "segments",
+    SLICES = "slices"
+}
+
+interface AbsoluteRelativeOptions {
+    /**
+     * Disable the rule in certain files
+     */
+    ignoreInFilesPatterns: string[];
+}
+interface LayersSlicesOptions {
+    /**
+     * Ignore cross-imports of types
+     * @default true
+     */
+    allowTypeImports: boolean;
+    /**
+     * Ignore certain import paths (import foo from '<path-to-ignore>')
+     */
+    ignorePatterns: string[];
+    /**
+     * Disable the rule in certain files
+     */
+    ignoreInFilesPatterns: string[];
+}
+interface PublicApiOptions {
+    /**
+     * Adjusts the depth.
+     * 'slices' will check for presence 'index' file at the slice level only,
+     * 'segments' at the slice and its segments level
+     * Default is 'slices', but 'segments' is recommended
+     * @default 'slices'
+     */
+    level: VALIDATION_LEVEL;
+    /**
+     * Disable the rule in certain files
+     */
+    ignoreInFilesPatterns: string[];
+}
+interface ESLintPluginFeatureSlicedRuleOptions {
+    absoluteRelative?: false | AbsoluteRelativeOptions;
+    layersSlices?: false | LayersSlicesOptions;
+    publicApi?: false | PublicApiOptions;
+}
+interface ESLintPluginFeatureSlicedOptions extends ESLintPluginFeatureSlicedRuleOptions {
+    sortImports?: false | ImportOrderConfigName;
+}
+declare function createPlugin(options?: ESLintPluginFeatureSlicedOptions): TypedFlatConfigItem;
+
+export { createPlugin as default };