@omnisass/library 0.4.0 → 0.4.1

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.
Files changed (41) hide show
  1. package/modules/utilities/helpers/list/_list-sum-numbers-safe.scss +4 -3
  2. package/modules/utilities/helpers/list/_list-sum-numbers.scss +4 -3
  3. package/modules/utilities/helpers/misc/_url-encode.scss +5 -4
  4. package/modules/utilities/helpers/number/_number-ceil-to.scss +5 -3
  5. package/modules/utilities/helpers/number/_number-clamp-max.scss +5 -3
  6. package/modules/utilities/helpers/number/_number-clamp-min.scss +5 -3
  7. package/modules/utilities/helpers/number/_number-clamp.scss +6 -3
  8. package/modules/utilities/helpers/number/_number-denormalize.scss +6 -3
  9. package/modules/utilities/helpers/number/_number-fibonacci.scss +4 -3
  10. package/modules/utilities/helpers/number/_number-floor-to.scss +5 -3
  11. package/modules/utilities/helpers/number/_number-format-with-separator.scss +5 -4
  12. package/modules/utilities/helpers/number/_number-normalize.scss +6 -3
  13. package/modules/utilities/helpers/number/_number-random-between-int.scss +5 -3
  14. package/modules/utilities/helpers/number/_number-random-between.scss +5 -3
  15. package/modules/utilities/helpers/number/_number-range.scss +6 -3
  16. package/modules/utilities/helpers/number/_number-round-to-nearest.scss +5 -3
  17. package/modules/utilities/helpers/number/_number-round-to.scss +5 -3
  18. package/modules/utilities/helpers/number/_number-strip-unit.scss +4 -3
  19. package/modules/utilities/helpers/string/_string-capitalize.scss +4 -3
  20. package/modules/utilities/helpers/string/_string-replace.scss +6 -3
  21. package/modules/utilities/helpers/string/_string-trim-end.scss +4 -3
  22. package/modules/utilities/helpers/string/_string-trim-start.scss +4 -3
  23. package/modules/utilities/helpers/string/_string-trim.scss +4 -3
  24. package/modules/utilities/validators/color/_is-color-light.scss +5 -4
  25. package/modules/utilities/validators/color/_is-color-list.scss +4 -3
  26. package/modules/utilities/validators/list/_is-list-contained.scss +5 -4
  27. package/modules/utilities/validators/number/_is-int-even.scss +4 -3
  28. package/modules/utilities/validators/number/_is-int-odd.scss +4 -3
  29. package/modules/utilities/validators/number/_is-int.scss +5 -3
  30. package/modules/utilities/validators/number/_is-number-has-unit.scss +4 -3
  31. package/modules/utilities/validators/number/_is-number-negative.scss +4 -3
  32. package/modules/utilities/validators/number/_is-number-positive.scss +4 -3
  33. package/modules/utilities/validators/number/_is-number-unitless.scss +4 -3
  34. package/modules/utilities/validators/number/_is-number-zero.scss +4 -3
  35. package/modules/utilities/validators/string/_is-string-contained.scss +5 -3
  36. package/modules/utilities/validators/string/_is-string-empty.scss +4 -3
  37. package/modules/utilities/validators/string/_is-string-ending-with.scss +5 -3
  38. package/modules/utilities/validators/string/_is-string-starting-with.scss +5 -3
  39. package/package.json +1 -1
  40. package/package.scss +2 -2
  41. package/test2.sh +0 -158
@@ -84,9 +84,10 @@
84
84
  /// измерения первого найденного числа.
85
85
  /// @throws {Warning} - Выводит предупреждение при обнаружении
86
86
  /// чисел с несовместимыми единицами измерения.
87
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
88
- /// значение, не соответствующее типу `list`. Компиляция Sass
89
- /// будет остановлена с ошибкой.
87
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
88
+ /// значение, не соответствующее необходимому типу:
89
+ ///
90
+ /// - `$list` → `list`
90
91
  @function list-sum-numbers-safe($list) {
91
92
 
92
93
  // Проверка типа входного параметра: ожидается список или arglist.
@@ -66,9 +66,10 @@
66
66
  /// @throws {Error} - Может выбросить ошибку при попытке
67
67
  /// сложить числа с несовместимыми единицами измерения
68
68
  /// (например, px + em).
69
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
70
- /// значение, не соответствующее типу `list`. Компиляция Sass
71
- /// будет остановлена с ошибкой.
69
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
70
+ /// значение, не соответствующее необходимому типу:
71
+ ///
72
+ /// - `$list` → `list`
72
73
  @function list-sum-numbers($list) {
73
74
 
74
75
  // Проверка типа входного параметра: ожидается список или arglist.
@@ -67,10 +67,11 @@
67
67
  /// @return {String} - Закодированная строка, где все символы
68
68
  /// из карты замены преобразованы в их процентное
69
69
  /// представление.
70
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
71
- /// значение, не соответствующее типу `string` (`$value`) или
72
- /// `map` (`$chars-map`). Компиляция Sass будет остановлена
73
- /// с ошибкой.
70
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
71
+ /// значение, не соответствующее необходимому типу:
72
+ ///
73
+ /// - `$value` → `string`
74
+ /// - `$chars-map` → `map`
74
75
  /// @require {function} string-replace - Вспомогательная
75
76
  /// функция замены подстрок в строке. Должна быть определена
76
77
  /// и доступна для корректной работы данной функции.
@@ -105,9 +105,11 @@
105
105
  /// @return {Number} - Число, округленное вверх до ближайшего
106
106
  /// значения, кратного `$nearest`. Сохраняет единицы
107
107
  /// измерения исходного числа `$value`.
108
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
109
- /// значение, не соответствующее типу `number`. Компиляция Sass
110
- /// будет остановлена с ошибкой.
108
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
109
+ /// значение, не соответствующее необходимому типу:
110
+ ///
111
+ /// - `$value` → `number`
112
+ /// - `$nearest` → `number`
111
113
  @function number-ceil-to($value, $nearest) {
112
114
 
113
115
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -86,9 +86,11 @@
86
86
  /// или `$value-max`. Если `$value` меньше или равно `$value-max`,
87
87
  /// возвращается `$value`. В противном случае возвращается
88
88
  /// `$value-max`.
89
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
90
- /// значение, не соответствующее типу `number`. Компиляция Sass
91
- /// будет остановлена с ошибкой.
89
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
90
+ /// значение, не соответствующее необходимому типу:
91
+ ///
92
+ /// - `$value` → `number`
93
+ /// - `$value-max` → `number`
92
94
  @function number-clamp-max($value, $value-max) {
93
95
 
94
96
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -94,9 +94,11 @@
94
94
  /// или `$value-min`. Если `$value` больше или равно `$value-min`,
95
95
  /// возвращается `$value`. В противном случае возвращается
96
96
  /// `$value-min`.
97
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
98
- /// значение, не соответствующее типу `number`. Компиляция Sass
99
- /// будет остановлена с ошибкой.
97
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
98
+ /// значение, не соответствующее необходимому типу:
99
+ ///
100
+ /// - `$value` → `number`
101
+ /// - `$value-min` → `number`
100
102
  @function number-clamp-min($value, $value-min) {
101
103
 
102
104
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -105,9 +105,12 @@
105
105
  /// диапазона.
106
106
  /// @throws {Warning} - когда `$value-min > $value-max` поведение
107
107
  /// функции может быть неинтуитивным.
108
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
109
- /// значение, не соответствующее типу `number`. Компиляция Sass
110
- /// будет остановлена с ошибкой.
108
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
109
+ /// значение, не соответствующее необходимому типу:
110
+ ///
111
+ /// - `$value` → `number`
112
+ /// - `$value-min` → `number`
113
+ /// - `$value-max` → `number`
111
114
  @function number-clamp($value, $value-min, $value-max) {
112
115
 
113
116
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -170,9 +170,12 @@
170
170
  /// @throws Не выбрасывает ошибок, безопасно обрабатывает все
171
171
  /// числовые значения. Формула математически корректна для
172
172
  /// любых числовых аргументов.
173
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
174
- /// значение, не соответствующее типу `number`. Компиляция Sass
175
- /// будет остановлена с ошибкой.
173
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
174
+ /// значение, не соответствующее необходимому типу:
175
+ ///
176
+ /// - `$value` → `number`
177
+ /// - `$value-min` → `number`
178
+ /// - `$value-max` → `number`
176
179
  @function number-denormalize($value, $value-min, $value-max) {
177
180
 
178
181
  // Проверка типа первого параметра: ожидается нормализованное числовое значение.
@@ -218,9 +218,10 @@
218
218
  /// - Второй элемент: всегда 1 (если `$n > 1`)
219
219
  /// - Каждый последующий элемент: сумма двух предыдущих
220
220
  /// - Все элементы: целые положительные числа
221
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
222
- /// значение, не соответствующее типу `number`. Компиляция Sass
223
- /// будет остановлена с ошибкой.
221
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
222
+ /// значение, не соответствующее необходимому типу:
223
+ ///
224
+ /// - `$n` → `number`
224
225
  @function number-fibonacci($n) {
225
226
 
226
227
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -110,9 +110,11 @@
110
110
  /// измерения исходного числа `$value`.
111
111
  /// @throws {Error} - Может выбросить ошибку если происходит
112
112
  /// деление на ноль.
113
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
114
- /// значение, не соответствующее типу `number`. Компиляция Sass
115
- /// будет остановлена с ошибкой.
113
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
114
+ /// значение, не соответствующее необходимому типу:
115
+ ///
116
+ /// - `$value` → `number`
117
+ /// - `$nearest` → `number`
116
118
  @function number-floor-to($value, $nearest) {
117
119
 
118
120
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -96,10 +96,11 @@
96
96
  /// часть исходного числа игнорируется.
97
97
  /// @throws {Error} - Может выбросить ошибку если `$value`
98
98
  /// не является числом или если `$separator` не является строкой.
99
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
100
- /// значение, не соответствующее типу `number (`$value`) или
101
- /// `string` (`$separator`). Компиляция Sass будет остановлена
102
- /// с ошибкой.
99
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
100
+ /// значение, не соответствующее необходимому типу:
101
+ ///
102
+ /// - `$value` → `number`
103
+ /// - `$separator` → `string`
103
104
  @function number-format-with-separator($value, $separator: ",") {
104
105
 
105
106
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -157,9 +157,12 @@
157
157
  /// @throws {Error} - Может выбросить ошибку деления на ноль, если
158
158
  /// `$value-min == $value-max`. В этом случае знаменатель формулы становится
159
159
  /// нулем, что приводит к математической неопределенности.
160
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
161
- /// значение, не соответствующее типу `number`. Компиляция Sass
162
- /// будет остановлена с ошибкой.
160
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
161
+ /// значение, не соответствующее необходимому типу:
162
+ ///
163
+ /// - `$value` → `number`
164
+ /// - `$value-min` → `number`
165
+ /// - `$value-max` → `number`
163
166
  @function number-normalize($value, $value-min, $value-max) {
164
167
 
165
168
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -78,9 +78,11 @@
78
78
  /// Должно быть больше или равно `$value-min` для корректных результатов.
79
79
  /// @return {Number} - Случайное целое число в диапазоне [`$value-min`, `$value-max`].
80
80
  /// Всегда возвращает целое число без единиц измерения.
81
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
82
- /// значение, не соответствующее типу `number`. Компиляция Sass
83
- /// будет остановлена с ошибкой.
81
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
82
+ /// значение, не соответствующее необходимому типу:
83
+ ///
84
+ /// - `$value-min` → `number`
85
+ /// - `$value-max` → `number`
84
86
  /// @throws {Warning} - При `$value-max < $value-min` результат
85
87
  /// может быть неожиданным.
86
88
  @function number-random-between-int($value-min, $value-max) {
@@ -117,9 +117,11 @@
117
117
  /// быть неожиданным (возможны отрицательные значения длины
118
118
  /// диапазона). Рекомендуется всегда передавать
119
119
  /// `$value-min ≤ $value-max`.
120
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
121
- /// значение, не соответствующее типу `number`. Компиляция Sass
122
- /// будет остановлена с ошибкой.
120
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
121
+ /// значение, не соответствующее необходимому типу:
122
+ ///
123
+ /// - `$value-min` → `number`
124
+ /// - `$value-max` → `number`
123
125
  @function number-random-between($value-min, $value-max) {
124
126
 
125
127
  // Проверка типа первого параметра: ожидается числовое значение
@@ -244,9 +244,12 @@
244
244
  /// - Последний элемент: ближайшее к `$end` значение, кратное шагу
245
245
  /// - Все элементы: равномерно распределены с шагом `$step`
246
246
  /// - Направление: соответствует соотношению `$start` и `$end`
247
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
248
- /// значение, не соответствующее типу `number`. Компиляция Sass
249
- /// будет остановлена с ошибкой.
247
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
248
+ /// значение, не соответствующее необходимому типу:
249
+ ///
250
+ /// - `$from` → `number`
251
+ /// - `$to` → `number`
252
+ /// - `$step` → `number`
250
253
  @function number-range($from, $to, $step: 1) {
251
254
 
252
255
  // Проверка типа первого параметра: ожидается числовое значение
@@ -128,9 +128,11 @@
128
128
  /// @throws {Error} - Может выбросить ошибку если `$value` или
129
129
  /// `$nearest` не являются числами, или если происходит
130
130
  /// деление на ноль.
131
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
132
- /// значение, не соответствующее типу `number`. Компиляция Sass
133
- /// будет остановлена с ошибкой.
131
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
132
+ /// значение, не соответствующее необходимому типу:
133
+ ///
134
+ /// - `$value` → `number`
135
+ /// - `$nearest` → `number`
134
136
  @function number-round-to-nearest($value, $nearest) {
135
137
 
136
138
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -111,9 +111,11 @@
111
111
  /// @throws {Error} - Может выбросить ошибку если `$precision`
112
112
  /// не является целым неотрицательным числом или если
113
113
  /// `$value` не является числом.
114
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
115
- /// значение, не соответствующее типу `number`. Компиляция Sass
116
- /// будет остановлена с ошибкой.
114
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
115
+ /// значение, не соответствующее необходимому типу:
116
+ ///
117
+ /// - `$value` → `number`
118
+ /// - `$precision` → `number`
117
119
  @function number-round-to($value, $precision: 2) {
118
120
 
119
121
  // Проверка типа первого параметра: ожидается числовое значение.
@@ -79,9 +79,10 @@
79
79
  /// @return {Number} - Безразмерное числовое значение, равное
80
80
  /// числовой части входного значения. Если входное значение
81
81
  /// уже было безразмерным, возвращается то же самое значение.
82
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
83
- /// значение, не соответствующее типу `number`. Компиляция Sass
84
- /// будет остановлена с ошибкой.
82
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
83
+ /// значение, не соответствующее необходимому типу:
84
+ ///
85
+ /// - `$value` → `number`
85
86
  @function number-strip-unit($value) {
86
87
 
87
88
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -74,9 +74,10 @@
74
74
  /// первый символ преобразован в верхний регистр, а все
75
75
  /// остальные символы остаются без изменений. Для пустой
76
76
  /// строки возвращает пустую строку.
77
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
78
- /// значение, не соответствующее типу `string`. Компиляция Sass
79
- /// будет остановлена с ошибкой.
77
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
78
+ /// значение, не соответствующее необходимому типу:
79
+ ///
80
+ /// - `$string` → `string`
80
81
  @function string-capitalize($string) {
81
82
 
82
83
  // Проверка типа входного параметра: ожидается строковое значение.
@@ -58,9 +58,12 @@
58
58
  /// `$replaceable` не найдена, возвращается оригинальная строка.
59
59
  /// @throws {Error} - Может вызвать ошибку глубины рекурсии при очень
60
60
  /// длинных строках с множественными заменами.
61
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
62
- /// значение, не соответствующее типу `string`. Компиляция Sass
63
- /// будет остановлена с ошибкой.
61
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
62
+ /// значение, не соответствующее необходимому типу:
63
+ ///
64
+ /// - `$string` → `string`
65
+ /// - `$replaceable` → `string`
66
+ /// - `$replacement` → `string`
64
67
  @function string-replace($string, $replaceable, $replacement: '') {
65
68
 
66
69
  // Проверка типа первого параметра: ожидается исходная строка.
@@ -50,9 +50,10 @@
50
50
  /// @return {String} - Возвращает новую строку, в которой удалены
51
51
  /// все пробелы с конца оригинальной строки.
52
52
  /// Если строка состоит только из пробелов, возвращается пустая строка.
53
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
54
- /// значение, не соответствующее типу `string`. Компиляция Sass
55
- /// будет остановлена с ошибкой.
53
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
54
+ /// значение, не соответствующее необходимому типу:
55
+ ///
56
+ /// - `$string` → `string`
56
57
  @function string-trim-end($string) {
57
58
 
58
59
  // Проверка типа входного параметра: ожидается строковое значение.
@@ -50,9 +50,10 @@
50
50
  /// @return {String} - Возвращает новую строку, в которой удалены
51
51
  /// все пробелы с начала оригинальной строки.
52
52
  /// Если строка состоит только из пробелов, возвращается пустая строка.
53
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
54
- /// значение, не соответствующее типу `string`. Компиляция Sass
55
- /// будет остановлена с ошибкой.
53
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
54
+ /// значение, не соответствующее необходимому типу:
55
+ ///
56
+ /// - `$string` → `string`
56
57
  @function string-trim-start($string) {
57
58
 
58
59
  // Проверка типа входного параметра: ожидается строковое значение.
@@ -51,9 +51,10 @@
51
51
  /// @return {String} - Возвращает новую строку, в которой удалены
52
52
  /// все пробелы с начала и конца оригинальной строки.
53
53
  /// Если строка состоит только из пробелов, возвращается пустая строка.
54
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
55
- /// значение, не соответствующее типу `string`. Компиляция Sass
56
- /// будет остановлена с ошибкой.
54
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
55
+ /// значение, не соответствующее необходимому типу:
56
+ ///
57
+ /// - `$string` → `string`
57
58
  @function string-trim($string) {
58
59
 
59
60
  // Проверка типа входного параметра: ожидается строковое значение.
@@ -127,10 +127,11 @@
127
127
  /// используется значение 50%, которое является
128
128
  /// общепринятым разделением между светлыми и темными
129
129
  /// тонами. Можно изменить для тонкой настройки.
130
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
131
- /// значение, не соответствующее типу `color` ($color) или
132
- /// `number` (`$threshold`). Компиляция Sass будет остановлена
133
- /// с ошибкой.
130
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
131
+ /// значение, не соответствующее необходимому типу:
132
+ ///
133
+ /// - `$color` → `color`
134
+ /// - `$threshold` → `number`
134
135
  @function is-color-light($color, $threshold: 50) {
135
136
 
136
137
  // Проверка типа первого параметра: ожидается цветовое значение.
@@ -103,9 +103,10 @@
103
103
  /// в списке являются цветами. Возвращает `false`, если
104
104
  /// хотя бы один элемент не является цветом. Для пустого
105
105
  /// списка возвращает `true`.
106
- /// @throws {Error} - Выбрасывает ошибку, если параметру `$list` передано
107
- /// значение, не соответствующее типу `list`. Компиляция Sass
108
- /// будет остановлена с ошибкой.
106
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
107
+ /// значение, не соответствующее необходимому типу:
108
+ ///
109
+ /// - `$list` → `list`
109
110
  @function is-color-list($list) {
110
111
 
111
112
  // Проверка типа входного параметра: ожидается список или arglist.
@@ -56,13 +56,14 @@
56
56
  ///
57
57
  /// position: $position;
58
58
  /// }
59
- /// @param {*} $value - Значение для поиска в списке
60
59
  /// @param {List} $list - Список, в котором выполняется поиск
60
+ /// @param {*} $value - Значение для поиска в списке
61
61
  /// @return {Boolean} - Возвращает `true`, если значение
62
62
  /// найдено в списке, иначе возвращает `false`.
63
- /// @throws {Error} - Выбрасывает ошибку, если параметру `$list` передано
64
- /// значение, не соответствующее типу `list`. Компиляция Sass
65
- /// будет остановлена с ошибкой.
63
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
64
+ /// значение, не соответствующее необходимому типу:
65
+ ///
66
+ /// - `$list` → `list`
66
67
  @function is-list-contained($list, $value) {
67
68
 
68
69
  // Проверка типа первого параметра: ожидается список или arglist.
@@ -64,9 +64,10 @@
64
64
  /// является целым числом и делится на 2 без остатка.
65
65
  /// Во всех остальных случаях возвращает `false`,
66
66
  /// включая нецелые числа и значения других типов.
67
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
68
- /// значение, не соответствующее типу `number`. Компиляция Sass
69
- /// будет остановлена с ошибкой.
67
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
68
+ /// значение, не соответствующее необходимому типу:
69
+ ///
70
+ /// - `$value` → `number`
70
71
  @function is-int-even($value) {
71
72
 
72
73
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -65,9 +65,10 @@
65
65
  /// является целым числом и не делится на 2 без остатка.
66
66
  /// Во всех остальных случаях возвращает `false`,
67
67
  /// включая нецелые числа и значения других типов.
68
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
69
- /// значение, не соответствующее типу `number`. Компиляция Sass
70
- /// будет остановлена с ошибкой.
68
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
69
+ /// значение, не соответствующее необходимому типу:
70
+ ///
71
+ /// - `$value` → `number`
71
72
  @function is-int-odd($value) {
72
73
 
73
74
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -120,9 +120,11 @@
120
120
  /// строгой проверки типов.
121
121
  /// @return {Boolean} - `true` если значение является
122
122
  /// целым числом, `false` во всех остальных случаях.
123
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
124
- /// значение, не соответствующее типу `number`. Компиляция Sass
125
- /// будет остановлена с ошибкой.
123
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
124
+ /// значение, не соответствующее необходимому типу:
125
+ ///
126
+ /// - `$value` → `number`
127
+ /// - `$set-strict-mode-local` → `boolean`
126
128
  @function is-int($value, $set-strict-mode-local: true) {
127
129
 
128
130
  // Проверка строгого режима: если включен, выполняется
@@ -78,9 +78,10 @@
78
78
  /// `math.unit($value)` не является пустой строкой).
79
79
  /// Возвращает `false` для безразмерных чисел и всех
80
80
  /// нечисловых значений.
81
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
82
- /// значение, не соответствующее типу `number`. Компиляция Sass
83
- /// будет остановлена с ошибкой.
81
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
82
+ /// значение, не соответствующее необходимому типу:
83
+ ///
84
+ /// - `$value` → `number`
84
85
  @function is-number-has-unit($value) {
85
86
 
86
87
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -70,9 +70,10 @@
70
70
  /// является числом и строго меньше нуля. Во всех
71
71
  /// остальных случаях возвращает `false`, включая
72
72
  /// ноль, положительные числа и значения других типов.
73
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
74
- /// значение, не соответствующее типу `number`. Компиляция Sass
75
- /// будет остановлена с ошибкой.
73
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
74
+ /// значение, не соответствующее необходимому типу:
75
+ ///
76
+ /// - `$value` → `number`
76
77
  @function is-number-negative($value) {
77
78
 
78
79
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -68,9 +68,10 @@
68
68
  /// является числом и строго больше нуля. Во всех
69
69
  /// остальных случаях возвращает `false`, включая
70
70
  /// ноль, отрицательные числа и значения других типов.
71
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
72
- /// значение, не соответствующее типу `number`. Компиляция Sass
73
- /// будет остановлена с ошибкой.
71
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
72
+ /// значение, не соответствующее необходимому типу:
73
+ ///
74
+ /// - `$value` → `number`
74
75
  @function is-number-positive($value) {
75
76
 
76
77
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -81,9 +81,10 @@
81
81
  /// `math.unit($value)` является пустой строкой).
82
82
  /// Возвращает `false` для чисел с единицами измерения и всех
83
83
  /// нечисловых значений.
84
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
85
- /// значение, не соответствующее типу `number`. Компиляция Sass
86
- /// будет остановлена с ошибкой.
84
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
85
+ /// значение, не соответствующее необходимому типу:
86
+ ///
87
+ /// - `$value` → `number`
87
88
  @function is-number-unitless($value) {
88
89
 
89
90
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -69,9 +69,10 @@
69
69
  /// является числом и строго равно нулю. Во всех
70
70
  /// остальных случаях возвращает `false`, включая
71
71
  /// ненулевые числа и значения других типов.
72
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
73
- /// значение, не соответствующее типу `number`. Компиляция Sass
74
- /// будет остановлена с ошибкой.
72
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
73
+ /// значение, не соответствующее необходимому типу:
74
+ ///
75
+ /// - `$value` → `number`
75
76
  @function is-number-zero($value) {
76
77
 
77
78
  // Проверка типа входного параметра: ожидается числовое значение.
@@ -102,9 +102,11 @@
102
102
  /// и `false` в противном случае. Возвращаемые значения:
103
103
  /// - `true`: подстрока существует в строке (хотя бы одно вхождение)
104
104
  /// - `false`: подстрока не найдена или является пустой строкой
105
- /// @throws {Error} - Выбрасывает ошибку, если параметрам передано
106
- /// значение, не соответствующее типу `string`. Компиляция Sass
107
- /// будет остановлена с ошибкой.
105
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
106
+ /// значение, не соответствующее необходимому типу:
107
+ ///
108
+ /// - `$string` → `string`
109
+ /// - `$substring` → `string`
108
110
  @function is-string-contained($string, $substring) {
109
111
 
110
112
  // Проверка типа первого параметра: ожидается строка для поиска.
@@ -50,9 +50,10 @@
50
50
  /// @return {Boolean} - Возвращает `true`, если длина строки
51
51
  /// равна нулю. Возвращает `false` для любой строки
52
52
  /// ненулевой длины, а также для значений других типов.
53
- /// @throws {Error} - Выбрасывает ошибку, если в параметры передано
54
- /// значение, не соответствующее типу `string`. Компиляция Sass
55
- /// будет остановлена с ошибкой.
53
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
54
+ /// значение, не соответствующее необходимому типу:
55
+ ///
56
+ /// - `$string` → `string`
56
57
  @function is-string-empty($string) {
57
58
 
58
59
  // Проверка типа входного параметра: ожидается строковое значение.
@@ -56,9 +56,11 @@
56
56
  /// указанной подстрокой. Возвращает `false`, если строка не заканчивается
57
57
  /// подстрокой, если подстрока длиннее строки, или если регистр
58
58
  /// символов не совпадает.
59
- /// @throws {Error} - Выбрасывает ошибку, если параметрам передано
60
- /// значение, не соответствующее типу `string`. Компиляция Sass
61
- /// будет остановлена с ошибкой.
59
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
60
+ /// значение, не соответствующее необходимому типу:
61
+ ///
62
+ /// - `$string` → `string`
63
+ /// - `$substring` → `string`
62
64
  @function is-string-ending-with($string, $substring) {
63
65
 
64
66
  // Проверка типа первого параметра: ожидается строка для проверки.
@@ -56,9 +56,11 @@
56
56
  /// с указанной подстроки. Возвращает `false`, если строка не
57
57
  /// начинается с подстроки, если подстрока длиннее строки, или
58
58
  /// если регистр символов не совпадает.
59
- /// @throws {Error} - Выбрасывает ошибку, если параметрам передано
60
- /// значение, не соответствующее типу `string`. Компиляция Sass
61
- /// будет остановлена с ошибкой.
59
+ /// @throws {Error} - Выбрасывает ошибку, если в параметр передано
60
+ /// значение, не соответствующее необходимому типу:
61
+ ///
62
+ /// - `$string` → `string`
63
+ /// - `$substring` → `string`
62
64
  @function is-string-starting-with($string, $substring) {
63
65
 
64
66
  // Проверка типа первого параметра: ожидается строка для проверки.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@omnisass/library",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "Библиотека функций и миксинов, написанная на языке CSS-препроцессора Sass. Она предназначена для того, чтобы упростить, ускорить и улучшить процесс создания стилей для веб-сайтов.",
5
5
  "main": "index.scss",
6
6
  "scripts": {
package/package.scss CHANGED
@@ -42,7 +42,7 @@ $title: "OmniSass";
42
42
  /// @name description
43
43
  /// @access private
44
44
  /// @type String
45
- $description: "Набор утилит, миксинов, расширений на языке препроцессора Sass для помощи в ускорении, упрощении и улучщения процесса написания CSS-стилей.";
45
+ $description: "Набор утилит, миксинов, расширений на языке препроцессора Sass для помощи в ускорении, упрощении и улучщения процесса написания CSS-стилей.";
46
46
 
47
47
  /// Текущая версия библиотеки - используется для контроля
48
48
  /// версий и отслеживания изменений.
@@ -53,7 +53,7 @@ $description: "Набор утилит, миксинов, расширений
53
53
  /// @name version
54
54
  /// @access private
55
55
  /// @type String | Number
56
- $version: "0.4.0";
56
+ $version: "0.4.1";
57
57
 
58
58
  /// Тип лицензии библиотеки - используется для указания
59
59
  /// условий использования и распространения.
package/test2.sh DELETED
@@ -1,158 +0,0 @@
1
- #!/bin/bash
2
-
3
- # Скрипт для генерации changes.md с изменениями с последнего тега
4
-
5
- set -e
6
-
7
- OUTPUT_FILE="changes.md"
8
- TEMP_FILE=".git_changes.tmp"
9
-
10
- # Функция для очистки временных файлов
11
- cleanup() {
12
- if [ -f "$TEMP_FILE" ]; then
13
- rm -f "$TEMP_FILE"
14
- fi
15
- }
16
-
17
- trap cleanup EXIT
18
-
19
- # Получаем последний тег
20
- echo "🔍 Поиск последнего тега..."
21
- LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
22
-
23
- if [ -z "$LAST_TAG" ]; then
24
- echo "⚠️ Теги не найдены. Используется первый коммит."
25
- TAG_HASH=$(git rev-list --max-parents=0 HEAD)
26
- LAST_TAG="начала репозитория"
27
- else
28
- TAG_HASH=$(git rev-list -n 1 "$LAST_TAG")
29
- fi
30
-
31
- # Получаем текущую ветку и хэш HEAD
32
- CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
33
- CURRENT_HASH=$(git rev-parse --short HEAD)
34
- CURRENT_DATE=$(date '+%Y-%m-%d %H:%M:%S')
35
-
36
- # Получаем количество коммитов
37
- COMMIT_COUNT=$(git rev-list --count "$TAG_HASH"..HEAD)
38
-
39
- echo "📊 Найдено $COMMIT_COUNT коммитов с тега $LAST_TAG"
40
-
41
- # Генерируем файл changes.md
42
- echo "# Список изменений" > "$OUTPUT_FILE"
43
- echo "" >> "$OUTPUT_FILE"
44
-
45
- echo "## 📋 Информация" >> "$OUTPUT_FILE"
46
- echo "" >> "$OUTPUT_FILE"
47
- echo "- **Последний тег:** \`$LAST_TAG\`" >> "$OUTPUT_FILE"
48
- echo "- **Текущая ветка:** \`$CURRENT_BRANCH\`" >> "$OUTPUT_FILE"
49
- echo "- **Хэш HEAD:** \`$CURRENT_HASH\`" >> "$OUTPUT_FILE"
50
- echo "- **Дата генерации:** $CURRENT_DATE" >> "$OUTPUT_FILE"
51
- echo "- **Количество коммитов:** $COMMIT_COUNT" >> "$OUTPUT_FILE"
52
- echo "" >> "$OUTPUT_FILE"
53
-
54
- if [ $COMMIT_COUNT -eq 0 ]; then
55
- echo "## 📭 Изменения отсутствуют" >> "$OUTPUT_FILE"
56
- echo "" >> "$OUTPUT_FILE"
57
- echo "Нет новых коммитов с тега \`$LAST_TAG\`" >> "$OUTPUT_FILE"
58
-
59
- echo "✅ Файл $OUTPUT_FILE создан (без изменений)"
60
- exit 0
61
- fi
62
-
63
- echo "## 📈 Сводка изменений" >> "$OUTPUT_FILE"
64
- echo "" >> "$OUTPUT_FILE"
65
-
66
- # Статистика по авторам
67
- echo "### 👥 Авторы изменений" >> "$OUTPUT_FILE"
68
- echo "" >> "$OUTPUT_FILE"
69
- git shortlog -s -n --no-merges "$TAG_HASH"..HEAD | while read line; do
70
- count=$(echo "$line" | awk '{print $1}')
71
- author=$(echo "$line" | awk '{$1=""; print substr($0,2)}')
72
- echo "- **$author:** $count коммит(ов)" >> "$OUTPUT_FILE"
73
- done
74
- echo "" >> "$OUTPUT_FILE"
75
-
76
- # Статистика изменений файлов
77
- echo "### 📊 Изменения файлов" >> "$OUTPUT_FILE"
78
- echo "" >> "$OUTPUT_FILE"
79
- echo '```diff' >> "$OUTPUT_FILE"
80
- git diff --stat "$TAG_HASH" HEAD >> "$TEMP_FILE" 2>/dev/null || echo "Статистика изменений недоступна" > "$TEMP_FILE"
81
- cat "$TEMP_FILE" >> "$OUTPUT_FILE"
82
- echo '```' >> "$OUTPUT_FILE"
83
- echo "" >> "$OUTPUT_FILE"
84
-
85
- # Группировка по типу коммитов (Conventional Commits)
86
- echo "## 🗂️ Изменения по категориям" >> "$OUTPUT_FILE"
87
- echo "" >> "$OUTPUT_FILE"
88
-
89
- # Новые возможности
90
- feat_count=$(git log --oneline --grep="^feat" "$TAG_HASH"..HEAD | wc -l)
91
- if [ $feat_count -gt 0 ]; then
92
- echo "### 🚀 Новые возможности ($feat_count)" >> "$OUTPUT_FILE"
93
- echo "" >> "$OUTPUT_FILE"
94
- git log --pretty=format:"- **%s** (\`%h\`)" --grep="^feat" "$TAG_HASH"..HEAD | sed 's/^feat:*//i' >> "$OUTPUT_FILE"
95
- echo "" >> "$OUTPUT_FILE"
96
- fi
97
-
98
- # Исправления ошибок
99
- fix_count=$(git log --oneline --grep="^fix" "$TAG_HASH"..HEAD | wc -l)
100
- if [ $fix_count -gt 0 ]; then
101
- echo "### 🐛 Исправления ошибок ($fix_count)" >> "$OUTPUT_FILE"
102
- echo "" >> "$OUTPUT_FILE"
103
- git log --pretty=format:"- **%s** (\`%h\`)" --grep="^fix" "$TAG_HASH"..HEAD | sed 's/^fix:*//i' >> "$OUTPUT_FILE"
104
- echo "" >> "$OUTPUT_FILE"
105
- fi
106
-
107
- # Документация
108
- docs_count=$(git log --oneline --grep="^docs" "$TAG_HASH"..HEAD | wc -l)
109
- if [ $docs_count -gt 0 ]; then
110
- echo "### 📚 Документация ($docs_count)" >> "$OUTPUT_FILE"
111
- echo "" >> "$OUTPUT_FILE"
112
- git log --pretty=format:"- **%s** (\`%h\`)" --grep="^docs" "$TAG_HASH"..HEAD | sed 's/^docs:*//i' >> "$OUTPUT_FILE"
113
- echo "" >> "$OUTPUT_FILE"
114
- fi
115
-
116
- # Рефакторинг
117
- refactor_count=$(git log --oneline --grep="^refactor" "$TAG_HASH"..HEAD | wc -l)
118
- if [ $refactor_count -gt 0 ]; then
119
- echo "### ♻️ Рефакторинг ($refactor_count)" >> "$OUTPUT_FILE"
120
- echo "" >> "$OUTPUT_FILE"
121
- git log --pretty=format:"- **%s** (\`%h\`)" --grep="^refactor" "$TAG_HASH"..HEAD | sed 's/^refactor:*//i' >> "$OUTPUT_FILE"
122
- echo "" >> "$OUTPUT_FILE"
123
- fi
124
-
125
- # Тесты
126
- test_count=$(git log --oneline --grep="^test" "$TAG_HASH"..HEAD | wc -l)
127
- if [ $test_count -gt 0 ]; then
128
- echo "### ✅ Тесты ($test_count)" >> "$OUTPUT_FILE"
129
- echo "" >> "$OUTPUT_FILE"
130
- git log --pretty=format:"- **%s** (\`%h\`)" --grep="^test" "$TAG_HASH"..HEAD | sed 's/^test:*//i' >> "$OUTPUT_FILE"
131
- echo "" >> "$OUTPUT_FILE"
132
- fi
133
-
134
- # Остальные коммиты
135
- other_count=$(git log --oneline --invert-grep --grep="^feat\|^fix\|^docs\|^refactor\|^test" "$TAG_HASH"..HEAD | wc -l)
136
- if [ $other_count -gt 0 ]; then
137
- echo "### 🔧 Прочие изменения ($other_count)" >> "$OUTPUT_FILE"
138
- echo "" >> "$OUTPUT_FILE"
139
- git log --pretty=format:"- %s (\`%h\`)" --invert-grep --grep="^feat\|^fix\|^docs\|^refactor\|^test" "$TAG_HASH"..HEAD >> "$OUTPUT_FILE"
140
- echo "" >> "$OUTPUT_FILE"
141
- fi
142
-
143
- # Полный список коммитов
144
- echo "## 📝 Полный список коммитов" >> "$OUTPUT_FILE"
145
- echo "" >> "$OUTPUT_FILE"
146
- git log --pretty=format:"- **%s**%n - Хэш: \`%h\`%n - Автор: %an%n - Дата: %ad" --date=short "$TAG_HASH"..HEAD >> "$OUTPUT_FILE"
147
- echo "" >> "$OUTPUT_FILE"
148
-
149
- # Команда для сравнения
150
- echo "## 🔗 Ссылки" >> "$OUTPUT_FILE"
151
- echo "" >> "$OUTPUT_FILE"
152
- echo "Для просмотра всех изменений выполните:" >> "$OUTPUT_FILE"
153
- echo '```bash' >> "$OUTPUT_FILE"
154
- echo "git log --oneline $LAST_TAG..HEAD" >> "$OUTPUT_FILE"
155
- echo '```' >> "$OUTPUT_FILE"
156
-
157
- echo "✅ Файл $OUTPUT_FILE успешно создан!"
158
- echo "📄 Просмотр: cat $OUTPUT_FILE | head -30"