@archoleat/reglib 1.5.4 → 1.7.0

package/README.md

@@ -24,27 +24,128 @@ bun i -D @archoleat/reglib
 
 ## List of Regex
 
-- `FONT_FILE_NAME_REGEX`: Matches FontFamily-FontWeight.woff2
+This library provides a collection of useful
+regular expressions for various use cases.
+Below is a list of the exported regex
+patterns along with their explanations:
 
-- `ITALIC_REGEX`: Searches for the words `Italic` or `italic`.
+- ATTRIBUTE_REGEX
 
-- `VARIABLE_FONT_REGEX`: Searches for the words `var` or `variable`.
+  - Pattern: `\[[^\]]+\]`.
+  - Description: Matches an attribute in square brackets.
+  - Example: Matches `[attr]`, `[data-test]`, but not `[attr or attr]`.
 
-- `selectors`
-  - `bem`
-    - `BLOCK_REGEX`
-    - `ELEMENT_REGEX`
-    - `MODIFIER_REGEX`
+- CLASS_REGEX
 
-  - `child`
-    - `ATTRIBUTE_REGEX`
-    - `CLASS_REGEX`
+  - Pattern: `\.[a-z0-9_-]+`.
+  - Description: Matches a CSS class name starting with a dot (.).
+  - Example: Matches `.class`, `.my-class`, `.class_name`, but not `class` or `.class!`.
 
-  - `nested`
-    - `ATTRIBUTE_REGEX`
-    - `CLASS_REGEX`
-    - `ELEMENT_REGEX`
-    - `MODIFIER_REGEX`
+- BLOCK_REGEX
+
+  - Pattern: `[a-z][a-z0-9]*(-[a-z0-9]+)*`.
+  - Description: Matches a BEM block name.
+  - Example: Matches `block`, `my-block`, `block-name`, but not `Block` or `block!`.
+
+- ELEMENT_REGEX
+
+  - Pattern: `(__[a-z0-9]+(-[a-z0-9]+)*)`.
+  - Description: Matches a BEM element name.
+  - Example: Matches `__element`, `__my-element`, but not `element` or `__element!`.
+
+- MODIFIER_REGEX
+
+  - Pattern: `(--[a-z0-9]+(-[a-z0-9]+)*)`.
+  - Description: Matches a BEM modifier name.
+  - Example: Matches `--modifier`, `--my-modifier`, but not `modifier` or `--modifier!`.
+
+- SIBLING_REGEX
+
+  - Pattern: `(?:[^ ,{}]+\s*)?\+\s*[^ ,{}]+`.
+  - Description: Matches a sibling selector in CSS.
+  - Example: Matches `+ p`, `div + p`, `.class + .another-class`, but not `div > p`.
+
+- CHILD_REGEX
+
+  - Pattern: `(?:[^ ,{}]+\s*)?>\s*[^ ,{}]+`.
+  - Description: Matches a child selector in CSS.
+  - Example: Matches `> p`, `div > p`, `.class > .another-class`, but not `div + p`.
+
+- ATTRIBUTE_SIBLING_REGEX
+
+  - Pattern: `\[[^\]]+\]\s*\+\s*[^ ,{}]+`.
+  - Description: Matches an attribute selector followed by a sibling selector.
+  - Example: Matches `[attr] + div`, `[data-test] + .class`.
+
+- ATTRIBUTE_CHILD_REGEX
+
+  - Pattern: `\[[^\]]+\]\s*>\s*[^ ,{}]+`.
+  - Description: Matches an attribute selector followed by a child selector.
+  - Example: Matches `[attr] > div`, `[data-test] > .class`.
+
+- CLASS_SIBLING_REGEX
+
+  - Pattern: `\.[a-z0-9_-]+\s*\+\s*[^ ,{}]+`.
+  - Description: Matches a class selector followed by a sibling selector.
+  - Example: Matches `.class + div`, `.my-class + .another-class`.
+
+- CLASS_CHILD_REGEX
+
+  - Pattern: `\.[a-z0-9_-]+\s*>\s*[^ ,{}]+`.
+  - Description: Matches a class selector followed by a child selector.
+  - Example: Matches `.class > div`, `.my-class > .another-class`.
+
+- NESTED_ATTRIBUTE_SIBLING_REGEX
+
+  - Pattern: `&\[[^\]]+\]\s*\+\s*[^ ,{}]+`.
+
+  - Description: Matches a nested attribute selector
+    followed by a sibling selector.
+
+  - Example: Matches `&[attr] + div`, `&[data-test] + .class`.
+
+- NESTED_ATTRIBUTE_CHILD_REGEX
+
+  - Pattern: `&\[[^\]]+\]\s*>\s*[^ ,{}]+`.
+
+  - Description: Matches a nested attribute selector
+    followed by a child selector.
+
+  - Example: Matches `&[attr] > div`, `&[data-test] > .class`.
+
+- NESTED_CLASS_SIBLING_REGEX
+
+  - Pattern: `&\.[a-z0-9_-]+\s*\+\s*[^ ,{}]+`.
+  - Description: Matches a nested class selector followed by a sibling selector.
+  - Example: Matches `&.class + div`, `&.my-class + .another-class`.
+
+- NESTED_CLASS_CHILD_REGEX
+
+  - Pattern: `&\.[a-z0-9_-]+\s*>\s*[^ ,{}]+`.
+  - Description: Matches a nested class selector followed by a child selector.
+  - Example: Matches `&.class > div`, `&.my-class > .another-class`.
+
+- NESTED_ATTRIBUTE_REGEX
+
+  - Pattern: `&\[[^\]]+\]`.
+  - Description: Matches a nested attribute selector.
+  - Example: Matches `&[attr]`, `&[data-test]`.
+
+- NESTED_CLASS_REGEX
+
+  - Pattern: `&\.[a-z0-9_-]+`.
+  - Description: Matches a nested class selector.
+  - Example: Matches `&.class`, `&.my-class`.
+
+- FONT_FILE_NAME_REGEX
+
+  - Pattern: A complex regex for matching font file names.
+
+  - Description: Matches font file names based on family,
+    weight, italic, variable, and extension.
+
+  - Example: Matches `Roboto-Bold.woff2`, `OpenSans-Italic-Variable.ttf`.
+    > More info [validate-font-file-name](https://github.com/archoleat/validate-font-file-name)
 
 ## Contributing
 

package/index.d.ts

@@ -1,5 +1,7 @@
 declare const FONT_FILE_NAME_REGEX: RegExp;
 
+declare const ATTRIBUTE_REGEX: string;
+declare const CLASS_REGEX: string;
 declare const BLOCK_REGEX = '[a-z][a-z0-9]*(-[a-z0-9]+)*';
 declare const ELEMENT_REGEX = '(__[a-z0-9]+(-[a-z0-9]+)*)';
 declare const MODIFIER_REGEX = '(--[a-z0-9]+(-[a-z0-9]+)*)';
@@ -15,13 +17,17 @@ declare const NESTED_CLASS_SIBLING_REGEX: string;
 declare const NESTED_CLASS_CHILD_REGEX: string;
 declare const NESTED_ATTRIBUTE_REGEX: string;
 declare const NESTED_CLASS_REGEX: string;
+declare const NESTED_MODIFIER_REGEX = '&--.+';
+declare const NESTED_ELEMENT_REGEX = '&__.+';
 
 export {
   ATTRIBUTE_CHILD_REGEX,
+  ATTRIBUTE_REGEX,
   ATTRIBUTE_SIBLING_REGEX,
   BLOCK_REGEX,
   CHILD_REGEX,
   CLASS_CHILD_REGEX,
+  CLASS_REGEX,
   CLASS_SIBLING_REGEX,
   ELEMENT_REGEX,
   FONT_FILE_NAME_REGEX,
@@ -32,5 +38,7 @@ export {
   NESTED_CLASS_CHILD_REGEX,
   NESTED_CLASS_REGEX,
   NESTED_CLASS_SIBLING_REGEX,
+  NESTED_ELEMENT_REGEX,
+  NESTED_MODIFIER_REGEX,
   SIBLING_REGEX,
 };

package/index.js

@@ -1 +1 @@
-const S="(Italic)",T="(Variable)",o="[A-Z][a-z]",G=`^${o}+(${o}+)?`,s=["Thin","Hairline","ExtraLight","UltraLight","Light","Regular","Medium","SemiBold","DemiBold","Bold","ExtraBold","UltraBold","Black","Heavy","ExtraBlack","UltraBlack"].join("|"),I=["otf","ttf","woff","woff2"].join("|"),c=`(${G})`,L=`(${s})`,X=`(${I})$`,A=[`${c}-${L}`,`(${S}?)(${T}?)`,`\\.${X}`].join(""),a=new RegExp(A),_="[a-z0-9]",E="[^ ,{}]+",t=String.raw`\[[^\]]+\]`,R=String.raw`\.[a-z0-9_-]+`,B="--",N="__",$=String.raw`\s*\+\s*`,n=String.raw`\s*>\s*`,r=`[a-z]${_}*(-${_}+)*`,i=`(${N}${_}+(-${_}+)*)`,O=`(${B}${_}+(-${_}+)*)`,D=String.raw`(?:${E}\s*)?${$}${E}`,l=String.raw`(?:${E}\s*)?${n}${E}`,C=`${t}${$}${E}`,g=`${t}${n}${E}`,M=`${R}${$}${E}`,e=`${R}${n}${E}`,H=`&${t}${$}${E}`,w=`&${t}${n}${E}`,F=`&${R}${$}${E}`,U=`&${R}${n}${E}`,d=`&${t}`,f=`&${R}`;export{g as ATTRIBUTE_CHILD_REGEX,C as ATTRIBUTE_SIBLING_REGEX,r as BLOCK_REGEX,l as CHILD_REGEX,e as CLASS_CHILD_REGEX,M as CLASS_SIBLING_REGEX,i as ELEMENT_REGEX,a as FONT_FILE_NAME_REGEX,O as MODIFIER_REGEX,w as NESTED_ATTRIBUTE_CHILD_REGEX,d as NESTED_ATTRIBUTE_REGEX,H as NESTED_ATTRIBUTE_SIBLING_REGEX,U as NESTED_CLASS_CHILD_REGEX,f as NESTED_CLASS_REGEX,F as NESTED_CLASS_SIBLING_REGEX,D as SIBLING_REGEX};
+const G="(Italic)",s="(Variable)",o="[A-Z][a-z]",I=`^${o}+(${o}+)?`,c=["Thin","Hairline","ExtraLight","UltraLight","Light","Regular","Medium","SemiBold","DemiBold","Bold","ExtraBold","UltraBold","Black","Heavy","ExtraBlack","UltraBlack"].join("|"),L=["otf","ttf","woff","woff2"].join("|"),X=`(${I})`,A=`(${c})`,N=`(${L})$`,a=[`${X}-${A}`,`(${G}?)(${s}?)`,`\\.${N}`].join(""),B=new RegExp(a),_="[a-z0-9]",E="[^ ,{}]+",R=String.raw`\[[^\]]+\]`,t=String.raw`\.[a-z0-9_-]+`,T="--",S="__",$=String.raw`\s*\+\s*`,n=String.raw`\s*>\s*`,r=`[a-z]${_}*(-${_}+)*`,i=`(${S}${_}+(-${_}+)*)`,D=`(${T}${_}+(-${_}+)*)`,O=String.raw`(?:${E}\s*)?${$}${E}`,l=String.raw`(?:${E}\s*)?${n}${E}`,C=`${R}${$}${E}`,M=`${R}${n}${E}`,g=`${t}${$}${E}`,e=`${t}${n}${E}`,F=`&${R}${$}${E}`,H=`&${R}${n}${E}`,w=`&${t}${$}${E}`,U=`&${t}${n}${E}`,d=`&${R}`,f=`&${t}`,x=`&${T}.+`,P=`&${S}.+`;export{M as ATTRIBUTE_CHILD_REGEX,R as ATTRIBUTE_REGEX,C as ATTRIBUTE_SIBLING_REGEX,r as BLOCK_REGEX,l as CHILD_REGEX,e as CLASS_CHILD_REGEX,t as CLASS_REGEX,g as CLASS_SIBLING_REGEX,i as ELEMENT_REGEX,B as FONT_FILE_NAME_REGEX,D as MODIFIER_REGEX,H as NESTED_ATTRIBUTE_CHILD_REGEX,d as NESTED_ATTRIBUTE_REGEX,F as NESTED_ATTRIBUTE_SIBLING_REGEX,U as NESTED_CLASS_CHILD_REGEX,f as NESTED_CLASS_REGEX,w as NESTED_CLASS_SIBLING_REGEX,P as NESTED_ELEMENT_REGEX,x as NESTED_MODIFIER_REGEX,O as SIBLING_REGEX};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@archoleat/reglib",
   "description": "Library with ready-to-use regex",
-  "version": "1.5.4",
+  "version": "1.7.0",
   "license": "MIT",
   "author": {
     "email": "archoleat@gmail.com",