Skip to content

Conversation

@1998code
Copy link
Owner

This pull request updates the README.md file to improve clarity, update content, and reorganize sections. Key changes include renaming the project, updating features and examples, reorganizing platform compatibility details, and revising the contributing guidelines.

Updates to Project and Features:

  • Renamed the project from "SwiftNEWKit" to "SwiftNEW" and updated the introductory section accordingly.
  • Updated the features table to include clearer descriptions and replaced outdated preview images with updated visuals. [1] [2]

Reorganization of Examples and Compatibility:

  • Simplified the example project description by removing "SwiftUI" from the path and updated the environment section to "Tested Platforms and Environment" with clearer compatibility details.
  • Updated the usage section to use "Import Package" instead of "Import SwiftNEWKit" for consistency.

Contributing and Documentation:

  • Replaced the FAQ and developer notes with a new "Contributing" section, encouraging contributions and providing guidelines for reporting issues and submitting pull requests.

@1998code 1998code requested a review from Copilot May 16, 2025 16:42
@1998code 1998code self-assigned this May 16, 2025
@1998code 1998code added the enhancement New feature or request label May 16, 2025
@1998code 1998code requested review from Copilot and removed request for Copilot May 16, 2025 16:43
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors the README.md to improve clarity, update content, and reorganize sections following the project rename.

  • Renames project from SwiftNEWKit to SwiftNEW and updates related references.
  • Refreshes the features table, preview/gallery sections, and reorganizes platform compatibility.
  • Introduces a new Contributing section while removing outdated FAQ and developer notes.
Comments suppressed due to low confidence (3)

README.md:41

  • Badge URLs still reference the old SwiftNEWKit repository. Update the paths to SwiftNEW to ensure the badges display correctly.
![GitHub release (latest by date)](https://img.shields.io/github/v/release/1998code/SwiftNEWKit?color=g&label=STABLE&style=for-the-badge)

README.md:6

  • [nitpick] The table header Description is generic. Consider renaming it to Feature or Feature Description for clarity.
| Description                                                     | Version   |

README.md:71

  • [nitpick] The instruction Import Package. is ambiguous; change it to something like Import the SwiftNEW package.
1. Import Package.

@1998code
Copy link
Owner Author

This pull request introduces several updates to the Demo/What's New? project, focusing on deployment target upgrades, dependency enhancements, and code simplifications. It also includes changes to the README and JSON data for better documentation and feature updates.

Deployment Target and Platform Updates:

  • Updated iOS deployment target to 17.0 and macOS deployment target to 14.0 in project.pbxproj. Added XROS_DEPLOYMENT_TARGET for visionOS 1.0. [1] [2] [3] [4]
  • Updated Package.swift to replace xros with visionOS and set the macOS target to 14.0.

Dependency Updates:

  • Added a new dependency, SwiftGlass, in Package.swift and Package.resolved. This enables the use of .glass() modifiers for UI elements. [1] [2] [3]

Code Simplifications and Feature Enhancements:

  • Simplified ContentView.swift by removing unused states and restructuring previews with the @Previewable attribute.
  • Enhanced SwiftNEW.swift to support visionOS and added .glass() effects for UI elements. [1] [2]

Data and Documentation Updates:

  • Updated data.json with a new version (6.0) and added a legacy version (5.5) for backward compatibility. [1] [2]
  • Revised the README to reflect the latest features, remove outdated sections, and improve clarity on supported platforms and contributions. [1] [2] [3]

These changes collectively modernize the project, improve maintainability, and enhance the user experience.

@1998code 1998code requested a review from Copilot May 16, 2025 17:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request primarily refactors the project’s README documentation, updates project naming and features, and revises various code components in the SwiftNEW module and demo application to align with new platform naming (visionOS) and API improvements (e.g. introducing SwiftGlass). Key updates include:

  • Renaming “SwiftNEWKit” to “SwiftNEW” and reorganizing README sections.
  • Updating conditional compilation directives and UI modifiers in SwiftNEW.swift to support visionOS, along with adding the SwiftGlass dependency.
  • Revamping demo project files (JSON localization files, preview code, and Xcode project settings) and adding a new GitHub workflow for JSON schema validation.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
Sources/SwiftNEW/SwiftNEW.swift Updated conditional directives from xrOS to visionOS and applied consistent glass UI modifiers.
README.md Refactored project title, features table, image assets, and documentation organization.
Package.swift Updated platform versions and replaced the custom xros platform with visionOS; added SwiftGlass.
Demo/What's New?/zh-Hant.lproj/data.json, zh-Hans.lproj/data.json, en.lproj/data.json Updated version numbers and content for localization files.
Demo/What's New?/What_s_New_App.swift Temporarily replaced ContentView with a simple demo Text view.
Demo/What's New?/ContentView.swift Adopted new preview macros and removed legacy code sections for a cleaner demo interface.
Demo/What's New?.xcodeproj/{project.xcworkspace/Package.resolved, project.pbxproj} Adjusted deployment targets and version metadata to align with the new release.
.github/workflows/validate-json.yml Added a GitHub workflow for JSON syntax and schema validation across localization files.

@1998code
Copy link
Owner Author

This pull request introduces a variety of changes, including the addition of a GitHub Actions workflow for validating JSON files, updates to project configuration files, dependency updates, and modifications to localized JSON data. Below is a summary of the most important changes grouped by theme:

Workflow Automation

  • Added a new GitHub Actions workflow (.github/workflows/validate-json.yml) to validate JSON files for syntax and schema compliance, and check localization completeness. This includes steps for scanning files, validating JSON syntax and schema, and generating a localization completeness report.

Project Configuration Updates

  • Updated the iOS deployment target to 17.0, macOS deployment target to 14.0, and added XROS_DEPLOYMENT_TARGET set to 1.0 in the project configuration (Demo/What's New?.xcodeproj/project.pbxproj). [1] [2] [3]
  • Incremented the project version to 15 and marketing version to 6.0. [1] [2]

Dependency Management

  • Updated the Swift Package Manager configuration (Demo/What's New?.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved) to include a new dependency, SwiftGlass (version 1.8.0), and incremented the package version to 3. [1] [2]

Code Changes

  • Refactored ContentView.swift to replace the previous state-based implementation with #Preview annotations for various SwiftUI previews. Removed unused states and the body implementation.
  • Replaced the ContentView reference in What_s_New_App.swift with a placeholder Text("Demo").

Localization Updates

  • Updated localized JSON files (Demo/What's New?/en.lproj/data.json and Demo/What's New?/zh-Hans.lproj/data.json) to include a new version 6.0 with updated content, moved version 5.5 to a new position, and removed redundant entries in the Chinese localization. [1] [2] [3] [4] [5] [6]

Copy link

@accesslint accesslint bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are accessibility issues in these changes.

@1998code 1998code requested a review from Copilot May 17, 2025 06:58
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates the project’s branding and documentation while refining the SwiftNEW source code and package configuration. Key changes include renaming the project and updating README content (with translations), refactoring UI code in SwiftNEW (including updating preprocessor directives and adding the SwiftGlass dependency), and modifying Package.swift and demo files for improved platform compatibility and demo presentation.

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Tests/SwiftNEWTests/SwiftNEWTests.swift Test file removed, potentially affecting automated test coverage.
Sources/SwiftNEW/SwiftNEW.swift Updates to conditional compilation for visionOS, added SwiftGlass usage, and minor logic improvements.
README files (various languages) Reorganization and updated documentation content and language-specific translations.
Package.swift Updated platform versions and added SwiftGlass dependency.
Demo/* Adjustments in demo files including data.json updates and simplified ContentView previews.

@1998code 1998code requested a review from Copilot May 17, 2025 07:05
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances SwiftNEW to version 6.0 by renaming the project, reorganizing documentation, adding SwiftGlass and visionOS support, and updating demo content.

  • Renamed SwiftNEWKit to SwiftNEW, restructured README and localized docs (features, examples, compatibility, contributing).
  • Integrated SwiftGlass dependency, replaced xrOS flags with visionOS, and applied .glass modifiers in SwiftNEW view.
  • Removed the outdated test file and updated demo JSON entries for version 6.0 and 5.5 across all locales.

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
Tests/SwiftNEWTests/SwiftNEWTests.swift Removed outdated test scaffold
Sources/SwiftNEW/SwiftNEW.swift Added import SwiftGlass, updated visionOS flags and modifiers
Package.swift Bumped macOS platform, replaced xros with visionOS, added SwiftGlass dependency
Demo/What's New?/en.lproj/data.json (and other locales) Inserted new version entries for 6.0 and 5.5
README.md & README/* Renamed project, reorganized sections, updated usage and contributing
Demo/What's New?.xcodeproj/project.pbxproj Updated deployment targets, marketing and project versions, added XROS setting
Demo/What's New?.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved Pinned SwiftGlass package
.github/workflows/validate-json.yml Added JSON schema and localization completeness validation
Comments suppressed due to low confidence (2)

Tests/SwiftNEWTests/SwiftNEWTests.swift:6

  • The entire test file was removed, eliminating any existing test coverage for SwiftNEW. Consider adding or updating unit tests to cover the new functionality and ensure ongoing reliability.
-import XCTest

Demo/What's New?.xcodeproj/project.pbxproj:310

  • [nitpick] CURRENT_PROJECT_VERSION is set to 15 while MARKETING_VERSION is 6.0; ensure the build number and marketing version follow your versioning scheme or adjust for clarity.
CURRENT_PROJECT_VERSION = 15;

1998code and others added 4 commits May 18, 2025 16:06
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@1998code
Copy link
Owner Author

This pull request introduces several significant updates, including the addition of a GitHub Actions workflow for JSON validation, project configuration updates, dependency changes, and content updates for localized JSON files. Below is a breakdown of the most important changes:

Automation and Validation

  • Added a new GitHub Actions workflow (.github/workflows/validate-json.yml) to validate JSON files for syntax and schema compliance, and to ensure localization completeness across languages. This includes schema definition, JSON scanning, and validation steps.

Project Configuration Updates

  • Updated CURRENT_PROJECT_VERSION to 15, IPHONEOS_DEPLOYMENT_TARGET to 17.0, MACOSX_DEPLOYMENT_TARGET to 14.0, and added support for additional platforms (appletvos, appletvsimulator, etc.) in Demo/What's New?.xcodeproj/project.pbxproj. [1] [2] [3] [4]

Dependency Management

  • Added SwiftGlass (version 1.8.0) as a new dependency in Demo/What's New?.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved and incremented the version field to 3. [1] [2] [3]

Code Simplification

  • Refactored ContentView.swift by removing unused states and consolidating the view structure. Introduced SwiftUI #Preview annotations for better preview support.

Localization Updates

  • Updated en.lproj/data.json and zh-Hans.lproj/data.json to include a new version (6.0) and moved version 5.5 to a later position. Removed redundant entries and cleaned up outdated content in the Chinese (zh-Hans) localization. [1] [2] [3] [4] [5] [6] [7]

@1998code
Copy link
Owner Author

This pull request introduces significant updates to the project, including the addition of a GitHub Actions workflow for JSON validation, updates to the Xcode project configuration to support additional languages and platforms, and improvements to the ContentView structure. It also modifies the data.json file to include new version entries and removes outdated content.

Workflow Automation

  • Added a new GitHub Actions workflow (.github/workflows/validate-json.yml) to validate JSON files for syntax and schema compliance, and to check localization completeness across different languages.

Xcode Project Updates

  • Added support for Japanese (ja) and Korean (ko) localization files in the Xcode project (Demo/What's New?.xcodeproj/project.pbxproj). [1] [2] [3]
  • Updated deployment targets and marketing version to align with the latest platform requirements (e.g., iOS 17, macOS 14, tvOS 17) and added support for additional platforms like tvOS. [1] [2] [3]

Dependency Management

  • Added the SwiftGlass package to the Swift Package Manager configuration (Demo/What's New?.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved).

Codebase Simplification

  • Refactored the ContentView in ContentView.swift to streamline the structure, remove unused states, and introduce #Preview annotations for better SwiftUI previews.

Data File Updates

  • Updated data.json to include a new version (6.0) while restoring version 5.5 for backward compatibility. Removed redundant entries such as "Serverless" and "Contribute." [1] [2] [3] [4]

@1998code
Copy link
Owner Author

This pull request introduces significant updates to the project, including a new GitHub Actions workflow for validating JSON files, updates to the Xcode project configuration, and content changes in the data.json file. These changes aim to improve JSON validation, add support for new languages, update deployment targets, and refine the app's content structure.

JSON Validation and Localization Workflow:

  • Added a GitHub Actions workflow (.github/workflows/validate-json.yml) to validate JSON files for syntax and schema compliance. This includes scanning for JSON files, validating their syntax, and ensuring schema adherence. Additionally, it checks localization completeness by comparing localized JSON files against the base language file.

Xcode Project Configuration Updates:

  • Added support for Japanese (ja) and Korean (ko) JSON files in the Xcode project by including them in the PBXFileReference and localization groups. [1] [2] [3]
  • Updated deployment targets for iOS (17.0), macOS (14.0), tvOS (17.0), and visionOS (1.0), and incremented the project version to 15 and marketing version to 6.0. [1] [2] [3]

Dependency Management:

  • Added a new Swift package dependency (SwiftGlass) with version 1.8.0 in Package.resolved. Updated the format version of the file to 3. [1] [2] [3]

Content Updates in data.json:

  • Updated the en.lproj/data.json file to include a new version (6.0) with updated content. Added back version 5.5 for historical completeness. Removed redundant entries for better clarity. [1] [2] [3] [4]

Code Cleanup and Simplification:

  • Simplified the ContentView.swift file by removing redundant states and replacing them with #Preview annotations for SwiftUI previews. This improves readability and aligns with modern SwiftUI practices.

@1998code 1998code merged commit 96b4c94 into main May 18, 2025
4 of 5 checks passed
@1998code 1998code deleted the 6.0-preview branch May 18, 2025 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants