Skip to content

Commit 585bb86

Browse files
committed
Appease the linter
1 parent f1101b0 commit 585bb86

File tree

3 files changed

+31
-32
lines changed

3 files changed

+31
-32
lines changed

specification/_types/analysis/kuromoji-plugin.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
import { integer } from '@_types/Numeric'
2121
import { CharFilterBase } from './char_filters'
22+
import { StopWords } from './StopWords'
2223
import { TokenizerBase } from './tokenizers'
2324
import { TokenFilterBase } from './token_filters'
24-
import { StopWords } from './StopWords'
2525

2626
export class KuromojiAnalyzer {
2727
type: 'kuromoji'

specification/_types/analysis/nori-plugin.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,3 @@ export class NoriPartOfSpeechTokenFilter extends TokenFilterBase {
3939
/** An array of part-of-speech tags that should be removed. */
4040
stoptags?: string[]
4141
}
42-

specification/_types/analysis/token_filters.ts

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ import {
2828
IcuTransformTokenFilter
2929
} from './icu-plugin'
3030
import {
31+
JaStopTokenFilter,
3132
KuromojiPartOfSpeechTokenFilter,
3233
KuromojiReadingFormTokenFilter,
33-
KuromojiStemmerTokenFilter,
34-
JaStopTokenFilter
34+
KuromojiStemmerTokenFilter
3535
} from './kuromoji-plugin'
36-
import { NoriPartOfSpeechTokenFilter } from './nori-plugin'
3736
import { SnowballLanguage } from './languages'
37+
import { NoriPartOfSpeechTokenFilter } from './nori-plugin'
3838
import { PhoneticTokenFilter } from './phonetic-plugin'
3939
import { StopWords } from './StopWords'
4040

@@ -52,11 +52,11 @@ export class CompoundWordTokenFilterBase extends TokenFilterBase {
5252
/** If `true`, only include the longest matching subword. Defaults to `false`. */
5353
only_longest_match?: boolean
5454
/** A list of subwords to look for in the token stream. If found, the subword is included in the token output.
55-
* Either this parameter or `word_list_path` must be specified.*/
55+
* Either this parameter or `word_list_path` must be specified.*/
5656
word_list?: string[]
5757
/** Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output.
58-
* This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.
59-
* Either this parameter or `word_list` must be specified. */
58+
* This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.
59+
* Either this parameter or `word_list` must be specified. */
6060
word_list_path?: string
6161
}
6262

@@ -67,7 +67,7 @@ export class DictionaryDecompounderTokenFilter extends CompoundWordTokenFilterBa
6767
export class HyphenationDecompounderTokenFilter extends CompoundWordTokenFilterBase {
6868
type: 'hyphenation_decompounder'
6969
/** Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file.
70-
* This path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported. */
70+
* This path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported. */
7171
hyphenation_patterns_path: string
7272
/** If `true`, do not match sub tokens in tokens that are in the word list. Defaults to `false`. */
7373
no_sub_matches?: boolean
@@ -131,7 +131,7 @@ export class StopTokenFilter extends TokenFilterBase {
131131
/** Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`. */
132132
stopwords?: StopWords
133133
/** Path to a file that contains a list of stop words to remove.
134-
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break. */
134+
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break. */
135135
stopwords_path?: string
136136
}
137137

@@ -184,7 +184,7 @@ export class WordDelimiterTokenFilterBase extends TokenFilterBase {
184184
/** Array of tokens the filter won’t split. */
185185
protected_words?: string[]
186186
/** Path to a file that contains a list of tokens the filter won’t split.
187-
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. */
187+
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. */
188188
protected_words_path?: string
189189
/** If `true`, the filter splits tokens at letter case transitions. For example: camelCase -> [ camel, Case ]. Defaults to `true`. */
190190
split_on_case_change?: boolean
@@ -219,18 +219,18 @@ export class AsciiFoldingTokenFilter extends TokenFilterBase {
219219
export class CommonGramsTokenFilter extends TokenFilterBase {
220220
type: 'common_grams'
221221
/** A list of tokens. The filter generates bigrams for these tokens.
222-
* Either this or the `common_words_path` parameter is required. */
222+
* Either this or the `common_words_path` parameter is required. */
223223
common_words?: string[]
224224
/** Path to a file containing a list of tokens. The filter generates bigrams for these tokens.
225-
* This path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break.
226-
* Either this or the `common_words` parameter is required. */
225+
* This path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break.
226+
* Either this or the `common_words` parameter is required. */
227227
common_words_path?: string
228228
/** If `true`, matches for common words matching are case-insensitive. Defaults to `false`. */
229229
ignore_case?: boolean
230230
/** If `true`, the filter excludes the following tokens from the output:
231-
* - Unigrams for common words
232-
* - Unigrams for terms followed by common words
233-
* Defaults to `false`. We recommend enabling this parameter for search analyzers. */
231+
* - Unigrams for common words
232+
* - Unigrams for terms followed by common words
233+
* Defaults to `false`. We recommend enabling this parameter for search analyzers. */
234234
query_mode?: boolean
235235
}
236236

@@ -245,13 +245,13 @@ export class ConditionTokenFilter extends TokenFilterBase {
245245
export class ElisionTokenFilter extends TokenFilterBase {
246246
type: 'elision'
247247
/** List of elisions to remove.
248-
* To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.
249-
* For custom `elision` filters, either this parameter or `articles_path` must be specified. */
248+
* To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.
249+
* For custom `elision` filters, either this parameter or `articles_path` must be specified. */
250250
articles?: string[]
251251
/** Path to a file that contains a list of elisions to remove.
252-
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break.
253-
* To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.
254-
* For custom `elision` filters, either this parameter or `articles` must be specified. */
252+
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break.
253+
* To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.
254+
* For custom `elision` filters, either this parameter or `articles` must be specified. */
255255
articles_path?: string
256256
/** If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`. */
257257
articles_case?: Stringified<boolean>
@@ -270,10 +270,10 @@ export class HunspellTokenFilter extends TokenFilterBase {
270270
/** If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`. */
271271
dedup?: boolean
272272
/** One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary.
273-
* By default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/<locale>` directory specified using the `lang`, `language`, or `locale` parameter. */
273+
* By default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/<locale>` directory specified using the `lang`, `language`, or `locale` parameter. */
274274
dictionary?: string
275275
/** Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary.
276-
* @aliases lang, language */
276+
* @aliases lang, language */
277277
locale: string
278278
/** If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`. */
279279
longest_only?: boolean
@@ -295,13 +295,13 @@ export class KeepTypesTokenFilter extends TokenFilterBase {
295295
export class KeepWordsTokenFilter extends TokenFilterBase {
296296
type: 'keep'
297297
/** List of words to keep. Only tokens that match words in this list are included in the output.
298-
* Either this parameter or `keep_words_path` must be specified. */
298+
* Either this parameter or `keep_words_path` must be specified. */
299299
keep_words?: string[]
300300
/** If `true`, lowercase all keep words. Defaults to `false`. */
301301
keep_words_case?: boolean
302302
/** Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output.
303-
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.
304-
* Either this parameter or `keep_words` must be specified. */
303+
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.
304+
* Either this parameter or `keep_words` must be specified. */
305305
keep_words_path?: string
306306
}
307307

@@ -310,14 +310,14 @@ export class KeywordMarkerTokenFilter extends TokenFilterBase {
310310
/** If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`. */
311311
ignore_case?: boolean
312312
/** Array of keywords. Tokens that match these keywords are not stemmed.
313-
* This parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. */
313+
* This parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. */
314314
keywords?: string | string[]
315315
/** Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed.
316-
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.
317-
* This parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. */
316+
* This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.
317+
* This parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. */
318318
keywords_path?: string
319319
/** Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed.
320-
* This parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`. */
320+
* This parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`. */
321321
keywords_pattern?: string
322322
}
323323

@@ -509,7 +509,7 @@ export class MinHashTokenFilter extends TokenFilterBase {
509509
/** Number of ways to hash each token in the stream. Defaults to `1`. */
510510
hash_count?: integer
511511
/** Number of hashes to keep from each bucket. Defaults to `1`.
512-
* Hashes are retained by ascending size, starting with the bucket’s smallest hash first. */
512+
* Hashes are retained by ascending size, starting with the bucket’s smallest hash first. */
513513
hash_set_size?: integer
514514
/** If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`. */
515515
with_rotation?: boolean

0 commit comments

Comments
 (0)