| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 1 | #!/usr/bin/env node |
| 2 | |
| Marc Kupietz | 20f33d9 | 2026-04-12 14:27:57 +0200 | [diff] [blame] | 3 | const packageVersion = require('../package.json').version; |
| 4 | |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 5 | const emoticonRegex = /^(\:\w+\:|\<[\/\\]?3|[\(\)\\\D|\*\$][\-\^]?[\:\;\=]|[\:\;\=B8][\-\^]?[3DOPp\@\$\*\\\)\(\/\|])(?=\s|[\!\.\?]|$)/; |
| Marc Kupietz | 3d52509 | 2026-04-11 20:44:32 +0200 | [diff] [blame] | 6 | const hashtagRegex = /^#(?=.*\p{L})[\p{L}\p{M}\p{N}]+$/u; |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 7 | const urlRegex = /^(ftp|http)s?:\/\/[^\s]+/; |
| 8 | const emailRegex = /^\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b/; |
| 9 | const addressRegex = /^@[a-zA-Z0-9]+/; |
| Marc Kupietz | 73f1749 | 2024-02-26 09:44:53 +0100 | [diff] [blame] | 10 | const actionWordRegex = /^:[^:]+:$/; |
| Marc Kupietz | 7497fc4 | 2025-12-11 15:47:34 +0100 | [diff] [blame] | 11 | const wikiEmojiRegex = /^\[_EMOJI:[^\]]+\]$/; |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 12 | |
| Marc Kupietz | 30634ff | 2025-12-18 11:39:03 +0100 | [diff] [blame] | 13 | // Load emoji data |
| 14 | let emojiData = {}; |
| 15 | try { |
| 16 | emojiData = require('./emoji_data.json'); |
| 17 | } catch (e) { |
| 18 | // Silent fallback if file doesn't exist (e.g. during initial setup before script run) |
| 19 | } |
| 20 | |
| Marc Kupietz | a7934e0 | 2025-12-18 07:25:53 +0100 | [diff] [blame] | 21 | // Function to strip emoji modifiers and zero-width joiners to get base emoji |
| 22 | function getBaseEmoji(emoji) { |
| 23 | const stripped = emoji |
| 24 | // Remove skin tone modifiers (U+1F3FB-U+1F3FF) |
| 25 | .replace(/[\u{1F3FB}-\u{1F3FF}]/gu, '') |
| 26 | // Remove zero-width joiners (U+200D) |
| 27 | .replace(/\u200D/g, '') |
| 28 | // Remove variation selectors (U+FE0F, U+FE0E) |
| 29 | .replace(/[\uFE0E\uFE0F]/g, ''); |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 30 | |
| Marc Kupietz | a7934e0 | 2025-12-18 07:25:53 +0100 | [diff] [blame] | 31 | // Extract the first emoji character using Array spread to handle multi-byte emoji |
| 32 | const chars = [...stripped]; |
| 33 | return chars.length > 0 ? chars[0] : stripped; |
| 34 | } |
| 35 | |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 36 | const optionDefinitions = [ |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 37 | { name: 'sparse', alias: 's', type: Boolean, description: 'Print only the files, lines that have POS annotations.' }, |
| Marc Kupietz | 20f33d9 | 2026-04-12 14:27:57 +0200 | [diff] [blame] | 38 | { name: 'version', alias: 'V', type: Boolean, description: 'Print the current package version.' }, |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 39 | { name: 'help', alias: 'h', type: Boolean, description: 'Print this usage guide.' }, |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 40 | ] |
| 41 | |
| 42 | const sections = [ |
| 43 | { |
| Marc Kupietz | 03ba301 | 2025-12-11 16:14:05 +0100 | [diff] [blame] | 44 | header: 'conllu-cmc', |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 45 | content: 'Reads CoNLL-U format from stdin and annotates emojis, emoticons, hashtags, URLs, email addresses, @addresses, and action words. Writes CoNLL-U format to stdout.' |
| 46 | }, |
| 47 | { |
| 48 | header: 'Synopsis', |
| Marc Kupietz | 202a36d | 2026-04-12 14:58:13 +0200 | [diff] [blame^] | 49 | content: '$ conllu-cmc [-s] < input.conllu > output.conllu\n$ cmc-tagger [-s] < input.conllu > output.conllu\n$ conllu-cmc -V\n$ cmc-tagger -V' |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 50 | }, |
| 51 | { |
| 52 | header: 'Options', |
| 53 | optionList: optionDefinitions |
| 54 | } |
| 55 | ] |
| 56 | |
| 57 | const getUsage = require('command-line-usage') |
| 58 | const commandLineArgs = require('command-line-args') |
| 59 | |
| 60 | var options; |
| 61 | try { |
| 62 | options = commandLineArgs(optionDefinitions) |
| 63 | } catch (e) { |
| 64 | console.error(e.message); |
| 65 | options = { help: true }; |
| 66 | } |
| 67 | |
| 68 | if (options.help) { |
| 69 | const usage = getUsage(sections); |
| 70 | console.log(usage); |
| Marc Kupietz | b75d926 | 2025-12-11 16:31:57 +0100 | [diff] [blame] | 71 | process.exit(0); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 72 | } |
| 73 | |
| Marc Kupietz | 20f33d9 | 2026-04-12 14:27:57 +0200 | [diff] [blame] | 74 | if (options.version) { |
| 75 | console.log(packageVersion); |
| 76 | process.exit(0); |
| 77 | } |
| 78 | |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 79 | const EmojiRegex = require('emoji-regex'); |
| 80 | const emojiRegex = EmojiRegex(); |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 81 | const { once } = require('events'); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 82 | const readline = require('readline'); |
| 83 | global.header = ''; |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 84 | global.fileheader = ''; |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 85 | global.standalone = false |
| 86 | |
| 87 | |
| 88 | const rl = readline.createInterface({ |
| 89 | input: process.stdin, |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 90 | terminal: false, |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 91 | |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 92 | }); |
| 93 | |
| 94 | |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 95 | async function writeOutput(text) { |
| 96 | if (!process.stdout.write(text)) { |
| 97 | await once(process.stdout, 'drain'); |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | |
| 102 | async function parseConllu(line) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 103 | if (line.match('#\\s*foundry')) { |
| 104 | if (line.match('=\\s*base')) { |
| 105 | if (options.sparse) { |
| 106 | global.standalone = true |
| 107 | } |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 108 | await writeOutput("# foundry = cmc\n"); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 109 | } else { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 110 | await writeOutput(`${line}\n`); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 111 | } |
| 112 | return |
| 113 | } |
| 114 | |
| 115 | if (global.standalone) { |
| 116 | if (line.match('^#\\s*filename')) { |
| 117 | global.fileheader = `${line}\n`; |
| 118 | return; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 119 | } else if (line.match('^#\\s*text_id')) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 120 | global.fileheader += `${line}\n`; |
| 121 | return; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 122 | } else if (line.match('^#\\s*eo[ft]')) { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 123 | await writeOutput(`${line}\n`); |
| Marc Kupietz | fd92b1d | 2024-03-13 10:51:29 +0100 | [diff] [blame] | 124 | return; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 125 | } else if (line.match('^#')) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 126 | global.header += `${line}\n`; |
| 127 | return; |
| 128 | } else if (line.trim().match('^$')) { |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 129 | if (global.header == "") { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 130 | await writeOutput("\n"); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 131 | } |
| 132 | global.header = ''; |
| 133 | return |
| 134 | } |
| 135 | } else { |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 136 | if (!line.match('^\\d+')) { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 137 | await writeOutput(`${line}\n`); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 138 | return; |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | const columns = line.trim().split('\t'); |
| 143 | |
| 144 | const word = columns[1]; |
| Marc Kupietz | a7934e0 | 2025-12-18 07:25:53 +0100 | [diff] [blame] | 145 | // Guard clause: if word is undefined, just output the line as-is |
| 146 | if (!word) { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 147 | await writeOutput(`${line}\n`); |
| Marc Kupietz | a7934e0 | 2025-12-18 07:25:53 +0100 | [diff] [blame] | 148 | return; |
| 149 | } |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 150 | |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 151 | var new_tag = null; |
| Marc Kupietz | 7497fc4 | 2025-12-11 15:47:34 +0100 | [diff] [blame] | 152 | if (word.match(wikiEmojiRegex)) { |
| 153 | new_tag = 'EMOWIKI'; |
| 154 | } else if (word.match(emojiRegex)) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 155 | new_tag = 'EMOIMG'; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 156 | } else if (word.match(actionWordRegex)) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 157 | new_tag = 'AKW'; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 158 | } else if (word.match(emoticonRegex)) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 159 | new_tag = 'EMOASC'; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 160 | } else if (word.match(hashtagRegex)) { |
| 161 | new_tag = 'HST'; |
| 162 | } else if (word.match(urlRegex)) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 163 | new_tag = 'URL'; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 164 | } else if (word.match(emailRegex)) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 165 | new_tag = 'EML'; |
| Marc Kupietz | 804750d | 2026-04-10 14:44:13 +0200 | [diff] [blame] | 166 | } else if (word.match(addressRegex)) { |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 167 | new_tag = 'ADR'; |
| 168 | } |
| 169 | if (new_tag) { |
| Marc Kupietz | 76007d6 | 2025-12-11 17:13:05 +0100 | [diff] [blame] | 170 | columns[4] = new_tag; |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 171 | columns[5] = '_'; |
| Marc Kupietz | a7934e0 | 2025-12-18 07:25:53 +0100 | [diff] [blame] | 172 | // For EMOIMG tokens, set lemma to the base emoji (without modifiers) |
| 173 | if (new_tag === 'EMOIMG') { |
| Marc Kupietz | 30634ff | 2025-12-18 11:39:03 +0100 | [diff] [blame] | 174 | const base = getBaseEmoji(word); |
| 175 | columns[2] = base; |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 176 | |
| Marc Kupietz | 30634ff | 2025-12-18 11:39:03 +0100 | [diff] [blame] | 177 | // Look up emoji metadata |
| 178 | // Try exact match first, then base emoji |
| 179 | const data = emojiData[word] || emojiData[base]; |
| 180 | if (data) { |
| 181 | // g=group|s=subgroup|q=qualified|v=version|n=name |
| 182 | columns[5] = `g=${data.g}|s=${data.s}|q=${data.q}|v=${data.v}|n=${data.n}`; |
| 183 | } |
| Marc Kupietz | a7934e0 | 2025-12-18 07:25:53 +0100 | [diff] [blame] | 184 | } |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 185 | if (global.standalone) { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 186 | await writeOutput(fileheader); |
| 187 | await writeOutput(header); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 188 | new_tag = null; |
| 189 | header = fileheader = ''; |
| 190 | } |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 191 | await writeOutput(columns.join('\t') + '\n'); |
| Marc Kupietz | a17c2e5 | 2026-04-10 14:21:27 +0200 | [diff] [blame] | 192 | } else if (!global.standalone) { |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 193 | await writeOutput(`${line}\n`); |
| Marc Kupietz | b43a518 | 2024-02-03 18:09:10 +0100 | [diff] [blame] | 194 | } |
| 195 | } |
| 196 | |
| Marc Kupietz | bbc9b22 | 2026-04-10 15:43:01 +0200 | [diff] [blame] | 197 | async function main() { |
| 198 | for await (const line of rl) { |
| 199 | await parseConllu(line); |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | main().catch((error) => { |
| 204 | console.error(error); |
| 205 | process.exit(1); |
| 206 | }); |