docs: add CHANGELOG

CHANGELOG.md

@@ -0,0 +1,149 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.6](https://github.com/prinsss/twitter-web-exporter/compare/v1.0.5..v1.0.6) - 2024-01-04
+
+### ⛰️  Features
+
+- Implement exporting search results - ([eac6b04](https://github.com/prinsss/twitter-web-exporter/commit/eac6b04012a4b852751584a8befbb2bc34c036c0))
+- Support parsing UserMedia - ([f80df50](https://github.com/prinsss/twitter-web-exporter/commit/f80df50b17e688ffa663a177aff14117f9ed48c9))
+
+### 🐛 Bug Fixes
+
+- Avoid exporting undefined values - ([b288201](https://github.com/prinsss/twitter-web-exporter/commit/b288201b0f634876de2e605be2a339a0e25151f6))
+- Update style of html exporter - ([ca3aafc](https://github.com/prinsss/twitter-web-exporter/commit/ca3aafc083507866cc169a050b731cbff3852fd4))
+
+## [1.0.5](https://github.com/prinsss/twitter-web-exporter/compare/v1.0.4..v1.0.5) - 2024-01-03
+
+### ⛰️  Features
+
+- Support custom media filename pattern - ([58441aa](https://github.com/prinsss/twitter-web-exporter/commit/58441aa150ad208ad0719c837aed0b7cf69999e8))
+- Rename utility files - ([a39334a](https://github.com/prinsss/twitter-web-exporter/commit/a39334ad5de10da39bf31ee88f457df3f6c5560b))
+
+## [1.0.4](https://github.com/prinsss/twitter-web-exporter/compare/v1.0.3..v1.0.4) - 2024-01-03
+
+### ⛰️  Features
+
+- Add instruction for using download manager - ([0095aa4](https://github.com/prinsss/twitter-web-exporter/commit/0095aa4e66b516ab706468206396933f89de24fd))
+
+### 🐛 Bug Fixes
+
+- Missing root style in scoped css - ([b4376ca](https://github.com/prinsss/twitter-web-exporter/commit/b4376caeecf8bb4c80ac10481916a95bb3a7fcc2))
+
+## [1.0.3](https://github.com/prinsss/twitter-web-exporter/compare/v1.0.2..v1.0.3) - 2024-01-01
+
+### ⛰️  Features
+
+- Add better error handling when extracting tweets - ([d5c2d45](https://github.com/prinsss/twitter-web-exporter/commit/d5c2d45a3be29bc73a5a6c7068b1a47cb85b8322))
+- Tweak logger buffer - ([8b2d83c](https://github.com/prinsss/twitter-web-exporter/commit/8b2d83c01438f533c04cc2775e2dee4d1fafe9e5))
+- Support parsing TweetTombstone type - ([0b51273](https://github.com/prinsss/twitter-web-exporter/commit/0b51273b5e34a100afa8579fbec7947cf15f9cfc))
+
+## [1.0.2](https://github.com/prinsss/twitter-web-exporter/compare/v1.0.1..v1.0.2) - 2024-01-01
+
+### ⛰️  Features
+
+- Add button for exporting media urls - ([b6faf8a](https://github.com/prinsss/twitter-web-exporter/commit/b6faf8af7ce729a841b588957ce381eb4c77ad39))
+
+### 🐛 Bug Fixes
+
+- Handle error when reading retweet source failed - ([8232470](https://github.com/prinsss/twitter-web-exporter/commit/8232470417ccb38aa78b3ab72ce655e784e04cc0))
+
+### 📚 Documentation
+
+- Add section about script limitation - ([2e49e61](https://github.com/prinsss/twitter-web-exporter/commit/2e49e61dbd35bfff92a3a626fcbf08b2892fc149))
+- Update README - ([10f5afb](https://github.com/prinsss/twitter-web-exporter/commit/10f5afbd4db55060b0137b0e7e68638ce3526184))
+
+## [1.0.1](https://github.com/prinsss/twitter-web-exporter/compare/v1.0.0..v1.0.1) - 2023-12-31
+
+### 🐛 Bug Fixes
+
+- Use file-saver instead of streamsaver - ([9521d41](https://github.com/prinsss/twitter-web-exporter/commit/9521d41df02d40b125f55a9252781d1575b99def))
+
+## [1.0.0] - 2023-12-30
+
+### ⛰️  Features
+
+- Add README - ([c0c0a9c](https://github.com/prinsss/twitter-web-exporter/commit/c0c0a9c0a4dd255c44a1dfb778a8d6e8882f7a35))
+- Add LICENSE - ([b137943](https://github.com/prinsss/twitter-web-exporter/commit/b137943b34d9a83c8771ffa0255d804c7cfad48c))
+- Export as CSV and HTML - ([407a0b3](https://github.com/prinsss/twitter-web-exporter/commit/407a0b312c29c42bee4e5beb866d4edd88313404))
+- Option to skip retweeted media - ([10b0288](https://github.com/prinsss/twitter-web-exporter/commit/10b02883c614357ecdd1e06af0c2765929fbf17e))
+- Export to JSON - ([3689888](https://github.com/prinsss/twitter-web-exporter/commit/3689888cbee80929b42e52d35dc8c84557eb1e1f))
+- Show full text for long tweets - ([1d4d670](https://github.com/prinsss/twitter-web-exporter/commit/1d4d6701395487f6394bbc7dcd95a0e1d33812f2))
+- Export selected data only - ([682dae3](https://github.com/prinsss/twitter-web-exporter/commit/682dae3c73c33984fc872bed7335659b608afa6f))
+- Export and download media - ([e2dfb70](https://github.com/prinsss/twitter-web-exporter/commit/e2dfb700ee009f19671fd1b04ab2fe09d07b60f0))
+- Download files with streamsaver - ([9ea7577](https://github.com/prinsss/twitter-web-exporter/commit/9ea7577d8f77505edf533daa94feb4bb78acd1a6))
+- Export media from tweets - ([95d38f3](https://github.com/prinsss/twitter-web-exporter/commit/95d38f33608b2d9f9b89a4f535ea45a50e200196))
+- New modal view for exporting data - ([b578754](https://github.com/prinsss/twitter-web-exporter/commit/b578754883602f35a87e452f27438fcc1b299e4e))
+- Upgrade dependencies - ([5ec12e3](https://github.com/prinsss/twitter-web-exporter/commit/5ec12e3384ee1ee1a018935c7095729f044c46a7))
+- Add debug mode option - ([b067631](https://github.com/prinsss/twitter-web-exporter/commit/b0676318c8078eb8cd6b48844ff31b995845a19c))
+- Update panel UI - ([738b3f7](https://github.com/prinsss/twitter-web-exporter/commit/738b3f78de1357715d87998552757fbb3718aa7e))
+- Add table pagination - ([95dea91](https://github.com/prinsss/twitter-web-exporter/commit/95dea910b79ae4728190a30a328668cbcda51f58))
+- Update script metadata - ([add0ee7](https://github.com/prinsss/twitter-web-exporter/commit/add0ee7583ad3e7b787745ee442a1e0247ee774b))
+- Format date time - ([8f88023](https://github.com/prinsss/twitter-web-exporter/commit/8f88023d56e3ddf88fefcb0bfc4c455531b220a8))
+- Add sorting for tables - ([10191dd](https://github.com/prinsss/twitter-web-exporter/commit/10191dd67e1d664b81e097049155b6e2a5a4f7ea))
+- Add searching for tables - ([36ff9e1](https://github.com/prinsss/twitter-web-exporter/commit/36ff9e10c49537bbb4fc702df9f4e56a9ff2b91f))
+- Show quote source of tweets - ([c62fb3e](https://github.com/prinsss/twitter-web-exporter/commit/c62fb3e1b5653b09ffb9a6ae271163b06699cf56))
+- Add many columns for user table - ([276ef79](https://github.com/prinsss/twitter-web-exporter/commit/276ef793535315ef00ad729170b7210089f85a86))
+- Add media preview for images and videos - ([7a2358e](https://github.com/prinsss/twitter-web-exporter/commit/7a2358e415d6fe568d73b41a0985cbf0258e4ce3))
+- Add ErrorBoundary - ([8d54c06](https://github.com/prinsss/twitter-web-exporter/commit/8d54c063fd7d970fe73bf7f24e2841e59af04977))
+- Show RT source for retweets - ([0b1b31e](https://github.com/prinsss/twitter-web-exporter/commit/0b1b31e4b0f04be91031b58b0e63c0d936be1026))
+- Pin the top row of tables - ([2c3fcf2](https://github.com/prinsss/twitter-web-exporter/commit/2c3fcf24eec0139f0442ecc8209c0b4d54adefbb))
+- Add table view for tweets - ([eb31d06](https://github.com/prinsss/twitter-web-exporter/commit/eb31d0646d0b8e0b81e16b44d9e4fc6b2c6fef89))
+- Add table view for users - ([ba3b769](https://github.com/prinsss/twitter-web-exporter/commit/ba3b769102784f09b4c66cd86538a8d32654a9aa))
+- Support loading-more in conversations - ([2101f5b](https://github.com/prinsss/twitter-web-exporter/commit/2101f5b61194c936efb961cee6ccd100299108ff))
+- Show module name in error messages - ([421069f](https://github.com/prinsss/twitter-web-exporter/commit/421069f14611e25560b52bd93cfb75328e748c22))
+- Add default app options - ([cbdc94b](https://github.com/prinsss/twitter-web-exporter/commit/cbdc94ba7192bf59ec05b6c9fa27216cb28aa479))
+- Add new module TweetDetail - ([3fc6972](https://github.com/prinsss/twitter-web-exporter/commit/3fc69723189f520c85c8ad8c00a65dd3def144c6))
+- Use different indicator color for tweets - ([f44aa2b](https://github.com/prinsss/twitter-web-exporter/commit/f44aa2b538db0d4e526751cd9a92fbef07afb400))
+- Remember last state of control panel - ([0da3df5](https://github.com/prinsss/twitter-web-exporter/commit/0da3df5a059f5fb24f8c03de384a7abb9e9dfb93))
+- Add settings panel - ([dad068b](https://github.com/prinsss/twitter-web-exporter/commit/dad068bcc0d1d5c66f74e5c26d15f3acda19e3c1))
+- App options manager - ([2e30391](https://github.com/prinsss/twitter-web-exporter/commit/2e30391ec9f6183420c84fbdecc4f30104fa730f))
+- Add extractor for likes and bookmarks - ([7afa64f](https://github.com/prinsss/twitter-web-exporter/commit/7afa64f22683a7dd0f633450eeee6d46bcdfc2ec))
+- Use generic functions to extract API data - ([af60771](https://github.com/prinsss/twitter-web-exporter/commit/af607719d32fa7eaaed840d6d56f186706945f10))
+- Add settings button - ([e848fdf](https://github.com/prinsss/twitter-web-exporter/commit/e848fdff647376cf79512a280e7ff14ed767002f))
+- Rewrite UI with tailwind css - ([4b99edc](https://github.com/prinsss/twitter-web-exporter/commit/4b99edc054d27c2b1981b86b3c181e7ec2494159))
+- Add daisyUI - ([0658eef](https://github.com/prinsss/twitter-web-exporter/commit/0658eef4c56773165ae6f8d8b18fc25ef6c039a0))
+- Rewrite styles with tailwind - ([dce685f](https://github.com/prinsss/twitter-web-exporter/commit/dce685f56415846e092a2428532522b64493319a))
+- Add tailwindcss - ([804a8f1](https://github.com/prinsss/twitter-web-exporter/commit/804a8f196a8dde6f765319e5bbf11fd64098c3e5))
+- Make dependencies external and use CDN - ([5c062e9](https://github.com/prinsss/twitter-web-exporter/commit/5c062e9037a7e4dca7f31a54d4ce66a46b8e186a))
+- Update UI components - ([d1f8415](https://github.com/prinsss/twitter-web-exporter/commit/d1f841537b8b5cb5f2f3b8319fbecbec6b19eb75))
+- Core and extension architecture - ([ab5b2c8](https://github.com/prinsss/twitter-web-exporter/commit/ab5b2c89a0bbe8c3db0bf22ec17c4fa251df7a54))
+- Initial commit - ([4141646](https://github.com/prinsss/twitter-web-exporter/commit/414164685a182b10a8b1e19943e028c6d2a549f2))
+
+### 🐛 Bug Fixes
+
+- Update script download URL - ([fef73b3](https://github.com/prinsss/twitter-web-exporter/commit/fef73b3648c7e63aedf690dcf2f1c55851a8d76d))
+- Duplicate file downloading - ([6c62eeb](https://github.com/prinsss/twitter-web-exporter/commit/6c62eebfa602bbbed20d256ad12663636a075351))
+- Support API endpoints when not signed in - ([e3faf85](https://github.com/prinsss/twitter-web-exporter/commit/e3faf8531a92ba7393615ded8b2a28fe887198ef))
+- Use local version of useSignal - ([69e24d0](https://github.com/prinsss/twitter-web-exporter/commit/69e24d0e96ea3151068e984bc4bee52cc1fb8f59))
+
+### 🚜 Refactor
+
+- Rearrange source files - ([fe71f4c](https://github.com/prinsss/twitter-web-exporter/commit/fe71f4c700d2da6ed0c22583d1294399b93be59a))
+- Update signal hooks - ([602323b](https://github.com/prinsss/twitter-web-exporter/commit/602323b88a1d93a81ee83ed37e24f6ceaf34262c))
+- Use icons from npm package - ([67e0a8e](https://github.com/prinsss/twitter-web-exporter/commit/67e0a8ea940a08e68c217845414da1dc2c69d46a))
+- Remove button components - ([a1c31ea](https://github.com/prinsss/twitter-web-exporter/commit/a1c31eae77e4bf3560708f05337a5ff3820a2f6a))
+- Add type predicate utils for API - ([ad1f7dc](https://github.com/prinsss/twitter-web-exporter/commit/ad1f7dc78377cc0e27e4c60cb5b3deca4868dbc8))
+- Simplify common modal component - ([6416a29](https://github.com/prinsss/twitter-web-exporter/commit/6416a2992dd88e598f37efc907e907e98763c2dc))
+- Extension manager and extension class - ([1ba5c1a](https://github.com/prinsss/twitter-web-exporter/commit/1ba5c1a9cbcbb68a9bf6c15dd7218013ac9e974c))
+- Remove tailwind-merge - ([f4cc3ed](https://github.com/prinsss/twitter-web-exporter/commit/f4cc3edc11813d10764f32664ba6fe270dfc0301))
+- Merge module files - ([baa592d](https://github.com/prinsss/twitter-web-exporter/commit/baa592d88e8d8456a33861ebb386263e1a2050e3))
+- Reuse module UI - ([a4fef7b](https://github.com/prinsss/twitter-web-exporter/commit/a4fef7b8ab0a900e3006a3ee224573153c97fb9b))
+
+### 📚 Documentation
+
+- Refine error messages - ([577c064](https://github.com/prinsss/twitter-web-exporter/commit/577c0643b50eea87fb9c61cb609427f25943a0e4))
+
+### 🎨 Styling
+
+- Sort module imports - ([49ce189](https://github.com/prinsss/twitter-web-exporter/commit/49ce189ff76570f30dbe2712396d218483a394b7))
+- Rename ModuleUI component - ([0dd2238](https://github.com/prinsss/twitter-web-exporter/commit/0dd223837a2c13dc0d077f515500b8017fded570))
+- Sort module imports - ([53feeb4](https://github.com/prinsss/twitter-web-exporter/commit/53feeb4de9172c88d7a3924d2a092890681e6532))
+
+### ⚙️ Miscellaneous Tasks
+
+- Update tsconfig.json - ([99894f6](https://github.com/prinsss/twitter-web-exporter/commit/99894f6c5864d0bf0d27ee24bd9e099f6312ccd1))
+- Pin dependencies version - ([37c975b](https://github.com/prinsss/twitter-web-exporter/commit/37c975b6358df8498c9061265f169434ab385eb2))
+
+<!-- generated by git-cliff -->

cliff.toml

@@ -0,0 +1,103 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    {% if previous.version %}\
+        ## [{{ version | trim_start_matches(pat="v") }}](<REPO>/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+    {% else %}\
+        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+    {% endif %}\
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+
+{% macro commit(commit) -%}
+    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}{% if commit.breaking %}[**breaking**] {% endif %}\
+        {{ commit.message | upper_first }} - ([{{ commit.id | truncate(length=7, end="") }}](<REPO>/commit/{{ commit.id }}))\
+{% endmacro -%}
+
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        {{ self::commit(commit=commit) }}
+    {%- endfor -%}
+    {% raw %}\n{% endraw %}\
+    {%- for commit in commits %}
+        {%- if not commit.scope -%}
+            {{ self::commit(commit=commit) }}
+        {% endif -%}
+    {% endfor -%}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+# postprocessors
+postprocessors = [
+  { pattern = '<REPO>', replace = "https://github.com/prinsss/twitter-web-exporter" }, # replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" },
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  # { pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->⛰️  Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore: bump version", skip = true },
+  { message = "^chore|ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "v[0-9].*"
+# regex for skipping tags
+skip_tags = "beta|alpha"
+# regex for ignoring tags
+ignore_tags = "rc"
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "newest"

package.json

@@ -11,6 +11,7 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
+    "changelog": "git-cliff -o CHANGELOG.md",
     "preview": "vite preview"
   },
   "dependencies": {
@@ -28,6 +29,7 @@
     "@types/node": "^20",
     "autoprefixer": "^10.4.16",
     "daisyui": "^4.4.24",
+    "git-cliff": "^1.4.0",
     "postcss-prefix-selector": "^1.16.0",
     "postcss-rem-to-pixel-next": "^5.0.3",
     "tailwindcss": "^3.4.0",