Renames command 'spo site list' to 'spo tenant site list'. Closes #6143

Author: ktskumar

docs/docs/about/release-notes.mdx

@@ -3848,7 +3848,7 @@ sidebar_position: 3
 - added information about the current user to status commands [#202](https://github.com/pnp/cli-microsoft365/issues/202)
 - fixed issue with completing input that doesn't match commands [#222](https://github.com/pnp/cli-microsoft365/issues/222)
 - fixed issue with escaping numeric input [#226](https://github.com/pnp/cli-microsoft365/issues/226)
-- changed the [entra oauth2grant list](../cmd/entra/oauth2grant/oauth2grant-list.mdx), [spo app list](../cmd/spo/app/app-list.mdx), [spo customaction list](../cmd/spo/customaction/customaction-list.mdx), [spo site list](../cmd/spo/site/site-list.mdx) commands to list all properties for output type JSON [#232](https://github.com/pnp/cli-microsoft365/issues/232), [#233](https://github.com/pnp/cli-microsoft365/issues/233), [#234](https://github.com/pnp/cli-microsoft365/issues/234), [#235](https://github.com/pnp/cli-microsoft365/issues/235)
+- changed the [entra oauth2grant list](../cmd/entra/oauth2grant/oauth2grant-list.mdx), [spo app list](../cmd/spo/app/app-list.mdx), [spo customaction list](../cmd/spo/customaction/customaction-list.mdx), [spo site list](../cmd/spo/tenant/tenant-site-list.mdx) commands to list all properties for output type JSON [#232](https://github.com/pnp/cli-microsoft365/issues/232), [#233](https://github.com/pnp/cli-microsoft365/issues/233), [#234](https://github.com/pnp/cli-microsoft365/issues/234), [#235](https://github.com/pnp/cli-microsoft365/issues/235)
 - fixed issue with generating clink completion file [#252](https://github.com/pnp/cli-microsoft365/issues/252)
 - added [user guide](../user-guide/installing-cli.mdx) [#236](https://github.com/pnp/cli-microsoft365/issues/236), [#237](https://github.com/pnp/cli-microsoft365/issues/237), [#238](https://github.com/pnp/cli-microsoft365/issues/238), [#239](https://github.com/pnp/cli-microsoft365/issues/239)
 
@@ -3864,7 +3864,7 @@ sidebar_position: 3
 
 - [spo customaction list](../cmd/spo/customaction/customaction-list.mdx) - lists user custom actions for site or site collection [#19](https://github.com/pnp/cli-microsoft365/issues/19)
 - [spo site get](../cmd/spo/site/site-get.mdx) - gets information about the specific site collection [#114](https://github.com/pnp/cli-microsoft365/issues/114)
-- [spo site list](../cmd/spo/site/site-list.mdx) - lists modern sites of the given type [#115](https://github.com/pnp/cli-microsoft365/issues/115)
+- [spo site list](../cmd/spo/tenant/tenant-site-list.mdx) - lists modern sites of the given type [#115](https://github.com/pnp/cli-microsoft365/issues/115)
 - [spo site add](../cmd/spo/site/site-add.mdx) - creates new modern site [#116](https://github.com/pnp/cli-microsoft365/issues/116)
 - [spo app remove](../cmd/spo/app/app-remove.mdx) - removes the specified app from the tenant app catalog [#9](https://github.com/pnp/cli-microsoft365/issues/9)
 - [spo site appcatalog add](../cmd/spo/site/site-appcatalog-add.mdx) - creates a site collection app catalog in the specified site [#63](https://github.com/pnp/cli-microsoft365/issues/63)

docs/docs/cmd/spo/site/site-list.mdx …docs/cmd/spo/tenant/tenant-site-list.mdxdocs/docs/cmd/spo/site/site-list.mdx renamed to docs/docs/cmd/spo/tenant/tenant-site-list.mdx docs/docs/cmd/spo/site/site-list.mdx renamed to docs/docs/cmd/spo/tenant/tenant-site-list.mdx

@@ -2,14 +2,20 @@ import Global from '/docs/cmd/_global.mdx';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# spo site list
+# spo tenant site list
 
 Lists modern sites of the given type
 
 ## Usage
 
 ```sh
-m365 spo site list [options]
+m365 spo tenant site list [options]
+```
+
+## Alias
+
+```sh
+m365 spo site list
 ```
 
 ## Options
@@ -49,31 +55,31 @@ To use this command you have to have permissions to access the tenant admin site
 List all sites in the currently connected tenant
 
 ```sh
-m365 spo site list
+m365 spo tenant site list
 ```
 
 List all group connected team sites in the currently connected tenant
 
 ```sh
-m365 spo site list --type TeamSite
+m365 spo tenant site list --type TeamSite
 ```
 
 List all communication sites in the currently connected tenant
 
 ```sh
-m365 spo site list --type CommunicationSite
+m365 spo tenant site list --type CommunicationSite
 ```
 
 List all group connected team sites that contain _project_ in the URL
 
 ```sh
-m365 spo site list --type TeamSite --filter "Url -like 'project'"
+m365 spo tenant site list --type TeamSite --filter "Url -like 'project'"
 ```
 
 List all sites in the currently connected tenant including OneDrive sites
 
 ```sh
-m365 spo site list --includeOneDriveSites
+m365 spo tenant site list --includeOneDriveSites
 ```
 
 ## Response

docs/docs/v6-upgrade-guidance.mdx

@@ -9,7 +9,7 @@ In CLI for Microsoft 365 we had several commands that were originally targeted a
 Command | Merged with
 --|--
 `spo site classic add` | [spo site add](./cmd/spo/site/site-add.mdx)
-`spo site classic list` | [spo site list](./cmd/spo/site/site-list.mdx)
+`spo site classic list` | [spo site list](./cmd/spo/tenant/tenant-site-list.mdx)
 `spo site classic set` | [spo site set](./cmd/spo/site/site-set.mdx)
 
 To fix a resulting issue with the `spo site list` command, the default value of the `type` option of that command has been removed.

docs/docs/v7-upgrade-guidance.mdx

@@ -128,7 +128,7 @@ Update your scripts to use the new options. Verify that your scripts work as int
 
 ### Removed `deleted` flag from `spo site list` command
 
-In the previous versions of CLI for Microsoft 365, you could get deleted sites from your SharePoint tenant using the command [spo site list](./cmd/spo/site/site-list.mdx) by providing the flag `--deleted`. In the latest release, we have removed this option from the command. To get all deleted sites in your tenant, you can now use the command [spo tenant recyclebinitem list](./cmd/spo/tenant/tenant-recyclebinitem-list.mdx).
+In the previous versions of CLI for Microsoft 365, you could get deleted sites from your SharePoint tenant using the command [spo site list](./cmd/spo/tenant/tenant-site-list.mdx) by providing the flag `--deleted`. In the latest release, we have removed this option from the command. To get all deleted sites in your tenant, you can now use the command [spo tenant recyclebinitem list](./cmd/spo/tenant/tenant-recyclebinitem-list.mdx).
 
 #### What action do I need to take?
 

docs/src/config/sidebars.ts

@@ -3400,7 +3400,7 @@ const sidebars: SidebarsConfig = {
             {
               type: 'doc',
               label: 'site list',
-              id: 'cmd/spo/site/site-list'
+              id: 'cmd/spo/tenant/tenant-site-list'
             },
             {
               type: 'doc',
@@ -3748,6 +3748,11 @@ const sidebars: SidebarsConfig = {
               label: 'tenant site archive',
               id: 'cmd/spo/tenant/tenant-site-archive'
             },
+            {
+              type: 'doc',
+              label: 'tenant site list',
+              id: 'cmd/spo/tenant/tenant-site-list'
+            },
             {
               type: 'doc',
               label: 'tenant site rename',

src/index.spec.ts

@@ -83,6 +83,7 @@ describe('Lazy loading commands', () => {
       'search externalconnection remove',
       'search externalconnection schema add',
       'spo folder rename',
+      'spo site list',
       'spo page template remove',
       'spo sp grant add',
       'spo sp grant list',

src/m365/spo/commands.ts

@@ -323,8 +323,9 @@ export default {
   TENANT_SETTINGS_LIST: `${prefix} tenant settings list`,
   TENANT_SETTINGS_SET: `${prefix} tenant settings set`,
   TENANT_SITE_ARCHIVE: `${prefix} tenant site archive`,
-  TENANT_SITE_MEMBERSHIP_LIST: `${prefix} tenant site membership list`,
+  TENANT_SITE_LIST: `${prefix} tenant site list`,
   TENANT_SITE_RENAME: `${prefix} tenant site rename`,
+  TENANT_SITE_MEMBERSHIP_LIST: `${prefix} tenant site membership list`,
   TENANT_SITE_UNARCHIVE: `${prefix} tenant site unarchive`,
   TERM_ADD: `${prefix} term add`,
   TERM_GET: `${prefix} term get`,

src/m365/spo/commands/tenant/SPOTenantSitePropertiesEnumerable.ts

@@ -0,0 +1,7 @@
+import { TenantSiteProperties } from './TenantSiteProperties.js';
+
+export interface SPOTenantSitePropertiesEnumerable {
+  _Child_Items_: TenantSiteProperties[];
+  NextStartIndex: number;
+  NextStartIndexFromSharePoint: string;
+}

src/m365/spo/commands/tenant/TenantSiteProperties.ts

@@ -0,0 +1,6 @@
+export interface TenantSiteProperties {
+  Status: string;
+  Title: string;
+  Url: string;
+  SiteId?: string;
+}

…m365/spo/commands/site/site-list.spec.ts …commands/tenant/tenant-site-list.spec.tssrc/m365/spo/commands/site/site-list.spec.ts renamed to src/m365/spo/commands/tenant/tenant-site-list.spec.ts src/m365/spo/commands/site/site-list.spec.ts renamed to src/m365/spo/commands/tenant/tenant-site-list.spec.ts

@@ -13,9 +13,9 @@ import { session } from '../../../../utils/session.js';
 import { sinonUtil } from '../../../../utils/sinonUtil.js';
 import { spo } from '../../../../utils/spo.js';
 import commands from '../../commands.js';
-import command from './site-list.js';
+import command from './tenant-site-list.js';
 
-describe(commands.SITE_LIST, () => {
+describe(commands.TENANT_SITE_LIST, () => {
   let log: string[];
   let logger: Logger;
   let loggerLogSpy: sinon.SinonSpy;
@@ -61,7 +61,7 @@ describe(commands.SITE_LIST, () => {
   });
 
   it('has correct name', () => {
-    assert.strictEqual(command.name, commands.SITE_LIST);
+    assert.strictEqual(command.name, commands.TENANT_SITE_LIST);
   });
 
   it('has a description', () => {
@@ -599,4 +599,9 @@ describe(commands.SITE_LIST, () => {
 
     await assert.rejects(command.action(logger, { options: { debug: true, filter: "Url like 'ctest'" } } as any), new CommandError('An error has occurred'));
   });
+
+  it('defines alias', () => {
+    const alias = command.alias();
+    assert.notStrictEqual(typeof alias, 'undefined');
+  });
 });