diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..98fe805 --- /dev/null +++ b/.gitignore @@ -0,0 +1,58 @@ +# ========================================== +# macOS System Files +# ========================================== +.DS_Store +.AppleDouble +.LSOverride +Icon +._* +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent +__MACOSX/ + +# ========================================== +# Windows System Files +# ========================================== +# Windows thumbnails +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on separate drives +$RECYCLE.BIN/ + +# Windows Installer temporary files +*.cab +*.msi +*.msm +*.msp + +# ========================================== +# Linux System Files +# ========================================== +# Temporary files (often created by text editors like Vim) +*~ + +# KDE directory preferences +.directory + +# Linux trash folder +.trash + +# ========================================== +# General Hidden Files +# ========================================== +# Ignore all hidden files/folders by default +.* + +# Keep the .gitignore file itself! +!.gitignore diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e1256a..456f97a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,45 @@ Include the packaged app as a ZIP file with the following naming convention: avalara-tax-v1.0.0.zip ``` +#### How to Generate the ZIP File + +When creating your ZIP file, it's important to exclude system files and hidden files that shouldn't be included in the archive. Use the following commands based on your operating system: + +##### macOS & Linux (Terminal) + +Both macOS and Linux use the `zip` utility. The `-x` flag is your best friend here—it tells the utility to exclude specific patterns. + +**The Command:** +```bash +zip -r my_archive.zip folder_to_zip/ -x "*.DS_Store" -x "__MACOSX/*" -x "*/.*" -x "Thumbs.db" +``` + +**Breakdown of the flags:** +- `-r`: Stands for "recursive." It tells the computer to look inside every subfolder. +- `"*.DS_Store"`: Excludes the macOS folder settings file. +- `"__MACOSX/*"`: Prevents the creation of those annoying resource fork folders. +- `"*/.*"`: The "nuclear option"—this excludes all hidden files (anything starting with a dot). +- `"Thumbs.db"`: Excludes the Windows thumbnail cache. + +##### Windows (PowerShell) + +Windows doesn't have a native "exclude" flag built into its basic `Compress-Archive` command. To do this cleanly without third-party software, you have to filter the files first and then pipe them into the zip command. + +**The Command:** +```powershell +Get-ChildItem -Path ".\folder_name" -Recurse -File | Where-Object { + $_.FullName -notmatch '\\\.DS_Store$' -and + $_.FullName -notmatch '__MACOSX' -and + $_.Name -notmatch '^\.' -and + $_.Name -notmatch 'Thumbs\.db' +} | Compress-Archive -DestinationPath "my_archive.zip" +``` + +**How this works:** +- `Get-ChildItem`: Grabs every file in your folder. +- `Where-Object`: This acts as a filter. We tell it to only keep files that do not match our "junk" patterns (no .DS_Store, no __MACOSX, no files starting with a dot, and no Thumbs.db). +- `Compress-Archive`: Takes that filtered list and zips it up. + --- ### 2. `manifest.json` diff --git a/tax/avalara-tax/avalara-tax-v0.1.3.zip b/tax/avalara-tax/avalara-tax-v0.1.3.zip deleted file mode 100644 index 06c961d..0000000 Binary files a/tax/avalara-tax/avalara-tax-v0.1.3.zip and /dev/null differ diff --git a/tax/avalara-tax/avalara-tax-v0.1.4.zip b/tax/avalara-tax/avalara-tax-v0.1.4.zip new file mode 100644 index 0000000..fca7770 Binary files /dev/null and b/tax/avalara-tax/avalara-tax-v0.1.4.zip differ diff --git a/tax/avalara-tax/manifest.json b/tax/avalara-tax/manifest.json index 2b8186e..81d16b0 100644 --- a/tax/avalara-tax/manifest.json +++ b/tax/avalara-tax/manifest.json @@ -1,8 +1,9 @@ { "name": "avalara-tax", + "displayName": "Avalara Tax", "domain": "tax", "description": "Sample Avalara tax app used for testing", - "version": "0.1.3", - "zip": "avalara-tax-v0.1.3.zip", - "sha256": "9cfd3ddd12cbc9f10935735467de61e366068cc5d82beab3c22bc965d7aafc53" + "version": "0.1.4", + "zip": "avalara-tax-v0.1.4.zip", + "sha256": "e7388f82312052991589fea07f7fbdbf6517f40b4ee33a12074f44cc34021c7e" }